DirectoryInfo.GetFiles Method (String, SearchOption)
Returns a file list from the current directory matching the given search pattern and using a value to determine whether to search subdirectories.
Assembly: mscorlib (in mscorlib.dll)
- Type: System.String
The search string. For example, "System*" can be used to search for all directories that begin with the word "System".
- Type: System.IO.SearchOption
One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories.
searchPattern contains one or more invalid characters defined by the GetInvalidPathChars method.
searchPattern is null.
searchOption is not a valid SearchOption value.
The path is invalid (for example, it is on an unmapped drive).
The caller does not have the required permission.
Therefore, when you are working with many files and directories, EnumerateFiles can be more efficient.
If there are no files in the DirectoryInfo, this method returns an empty array.
The following wildcard specifiers are permitted in searchPattern.
Zero or more characters.
Exactly one character.
The order of the returned file names is not guaranteed; use the Sort() method if a specific sort order is required.
Wildcards are permitted. For example, the searchPattern string "*.txt" searches for all file names having an extension of "txt". The searchPattern string "s*" searches for all file names beginning with the letter "s". If there are no files, or no files that match the searchPattern string in the DirectoryInfo, this method returns an empty array.
When using the asterisk wildcard character in a searchPattern (for example, "*.txt"), the matching behavior varies depending on the length of the specified file extension. A searchPattern with a file extension of exactly three characters returns files with an extension of three or more characters, where the first three characters match the file extension specified in the searchPattern. A searchPattern with a file extension of one, two, or more than three characters returns only files with extensions of exactly that length that match the file extension specified in the searchPattern. When using the question mark wildcard character, this method returns only files that match the specified file extension. For example, given two files in a directory, "file1.txt" and "file1.txtother", a search pattern of "file?.txt" returns only the first file, while a search pattern of "file*.txt" returns both files.
The following list shows the behavior of different lengths for the searchPattern parameter:
"*.abc" returns files having an extension of.abc,.abcd,.abcde,.abcdef, and so on.
"*.abcd" returns only files having an extension of.abcd.
"*.abcde" returns only files having an extension of.abcde.
"*.abcdef" returns only files having an extension of.abcdef.
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" will return "longfilename.txt" because the equivalent 8.3 file name format would be "longf~1.txt".
This method pre-populates the values of the following FileInfo properties:
The following example shows how to get a list of files from a directory by using different search options. The example assumes a directory that has files named log1.txt, log2.txt, test1.txt, test2.txt, test3.txt, and a subdirectory that has a file named SubFile.txt.
Imports System.IO Module Module1 Sub Main() Dim di As DirectoryInfo = New DirectoryInfo("C:\ExampleDir") Console.WriteLine("No search pattern returns:") For Each fi In di.GetFiles() Console.WriteLine(fi.Name) Next Console.WriteLine() Console.WriteLine("Search pattern *2* returns:") For Each fi In di.GetFiles("*2*") Console.WriteLine(fi.Name) Next Console.WriteLine() Console.WriteLine("Search pattern test?.txt returns:") For Each fi In di.GetFiles("test?.txt") Console.WriteLine(fi.Name) Next Console.WriteLine() Console.WriteLine("Search pattern AllDirectories returns:") For Each fi In di.GetFiles("*", SearchOption.AllDirectories) Console.WriteLine(fi.Name) Next End Sub End Module ' This code produces output similar to the following: ' No search pattern returns: ' log1.txt ' log2.txt ' test1.txt ' test2.txt ' test3.txt ' Search pattern *2* returns: ' log2.txt ' test2.txt ' Search pattern test?.txt returns: ' test1.txt ' test2.txt ' test3.txt ' Search pattern AllDirectories returns: ' log1.txt ' log2.txt ' test1.txt ' test2.txt ' test3.txt ' SubFile.txt ' Press any key to continue . . .
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.