GetDirectories Method (String, SearchOption)
Collapse the table of content
Expand the table of content

DirectoryInfo.GetDirectories Method (String, SearchOption)

 

Returns an array of directories in the current DirectoryInfo matching the given search criteria and using a value to determine whether to search subdirectories.

Namespace:   System.IO
Assembly:  mscorlib (in mscorlib.dll)

member GetDirectories : 
        searchPattern:string *
        searchOption:SearchOption -> DirectoryInfo[]

Parameters

searchPattern
Type: System.String

The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters (see Remarks), but doesn't support regular expressions. The default pattern is "*", which returns all files.

searchOption
Type: System.IO.SearchOption

One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories.

Return Value

Type: System.IO.DirectoryInfo[]

An array of type DirectoryInfo matching searchPattern.

Exception Condition
ArgumentException

searchPattern contains one or more invalid characters defined by the GetInvalidPathChars method.

ArgumentNullException

searchPattern is null.

ArgumentOutOfRangeException

searchOption is not a valid SearchOption value.

DirectoryNotFoundException

The path encapsulated in the DirectoryInfo object is invalid (for example, it is on an unmapped drive).

UnauthorizedAccessException

The caller does not have the required permission.

searchPattern can be a combination of literal and wildcard characters, but doesn't support regular expressions. The following wildcard specifiers are permitted in searchPattern.

Wildcard specifier

Matches

* (asterisk)

Zero or more characters in that position.

? (question mark)

Zero or one character in that position.

Characters other than the wildcard are literal characters. For example, the string "*t" searches for all names in ending with the letter "t". ". The searchPattern string "s*" searches for all names in path beginning with the letter "s".

If there are no subdirectories, or no subdirectories match the searchPattern parameter, this method returns an empty array.

This method pre-populates the values of the following DirectoryInfo properties:

The following example lists all of the directories and files that begin with the letter "c" in "c:\".

No code example is currently available or this language may not be supported.

FileIOPermission

for reading from files and directories and for access to the path. Associated enumerations: FileIOPermissionAccess.Read, FileIOPermissionAccess.PathDiscovery

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft