Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Directory.GetFileSystemEntries Method (String, String, SearchOption)

Gets an array of all the file names and directory names that match a search pattern in a specified path, and optionally searches subdirectories.

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

public static string[] GetFileSystemEntries(
	string path,
	string searchPattern,
	SearchOption searchOption
)

Parameters

path
Type: System.String
The directory to search.
searchPattern
Type: System.String
The string used to search for all files or directories that match its search pattern. The default pattern is for all files and directories: "*"
searchOption
Type: System.IO.SearchOption
The option that specifies whether the search operation should include only the current directory or should include all subdirectories.
The default value is TopDirectoryOnly.

Return Value

Type: System.String[]
An array of file system entries that match the search criteria.

ExceptionCondition
ArgumentException

path is a zero-length string, contains only white space, or contains invalid characters as defined by GetInvalidPathChars.

- or -

searchPattern does not contain a valid pattern.

ArgumentNullException

path is null.

-or-

searchPattern is null.

ArgumentOutOfRangeException

searchOption is not a valid SearchOption value.

DirectoryNotFoundException

path is invalid, such as referring to an unmapped drive.

IOException

path is a file name.

PathTooLongException

The specified path, file name, or combined exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters and file names must be less than 260 characters.

SecurityException

The caller does not have the required permission.

UnauthorizedAccessException

The caller does not have the required permission.

The following wildcard specifiers are permitted in the searchPattern parameter.

Wildcard character

Description

*

Zero or more characters.

?

Exactly one character.

You can specify relative path information with the path parameter. Relative path information is interpreted as relative to the current working directory, which you can determine by using the GetCurrentDirectory method.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

Show:
© 2015 Microsoft