Specifies how many levels of subfolders are scanned when IncludeSubdirectories is enabled.

Syntax

Connect-Excel -DirectoryRetrievalDepth string

Data Type

cstr

Default Value

"-1"

Remarks

This connection property only takes effect when the IncludeSubdirectories connection property is set to True and the URI connection property is set to a folder, rather than a workbook file.

When IncludeSubdirectories is enabled, this connection property specifies how many layers of nested folders, relative to the target folder (specified in the URI connection property), the cmdlet includes when it searches for workbook files.

For example, a DirectoryRetrievalDepth of 2 means that subfolders of the target folder, and subfolders of those folders, are included, but not further subfolders.

A DirectoryRetrievalDepth of -1 specifies that all subfolders are scanned.