Returns the names of files (including their paths) that match the specified search pattern in the specified directory, using a value to determine whether to search subdirectories.
Syntax
Parameters
- path
- searchPattern
- searchOption
Returns
An array of the full names (including paths) for the files in the specified directory that match the specified search pattern and option, or an empty array if no files are found.
Remarks
The returned file names are appended to the supplied parameter path and the order of the returned file names is not guaranteed; use the erload:System.Array.Sort method if a specific sort order is required.
searchPattern can be a combination of literal and wildcard characters, but doesn't support regular expressions. The following wildcard specifiers are permitted in searchPattern.
| * (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 searchPattern string "*t" searches for all names in path ending with the letter "t". The searchPattern string "s*" searches for all names in path beginning with the letter "s".
searchPattern cannot end in two periods ("..") or contain two periods ("..") followed by Path.DirectorySeparatorChar or Path.AltDirectorySeparatorChar, nor can it contain any invalid characters. You can query for invalid characters by using the Path.GetInvalidPathChars method.
When you use the asterisk wildcard character in a searchPattern such as "*.txt", the number of characters in the specified extension affects the search as follows:
If the specified extension is exactly three characters long, the method returns files with extensions that begin with the specified extension. For example, "*.xls" returns both "book.xls" and "book.xlsx".
In all other cases, the method returns files that exactly match the specified extension. For example, "*.ai" returns "file.ai" but not "file.aif".
When you use the question mark wildcard character, this method returns only files that match the specified file extension. For example, given two files, "file1.txt" and "file1.txtother", in a directory, a search pattern of "file?.txt" returns just the first file, whereas a search pattern of "file*.txt" returns both files.
Because this method checks against file names with both the 8.3 file name format and the long file name format, a search pattern similar to "*1*.txt" may return unexpected file names. For example, using a search pattern of "*1*.txt" returns "longfilename.txt" because the equivalent 8.3 file name format is "LONGFI~1.TXT".
The erload:System.IO.Directory.EnumerateFiles and erload:System.IO.Directory.GetFiles methods differ as follows: When you use erload:System.IO.Directory.EnumerateFiles, you can start enumerating the collection of names before the whole collection is returned; when you use erload:System.IO.Directory.GetFiles, you must wait for the whole array of names to be returned before you can access the array. Therefore, when you are working with many files and directories, erload:System.IO.Directory.EnumerateFiles can be more efficient.
The file names include the full path.
The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory. To obtain the current working directory, see Directory.GetCurrentDirectory.
The path parameter is not case-sensitive.
For a list of common I/O tasks, see Common I/O Tasks.
Requirements
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0