.NET Framework Class Library
Directory..::.GetFiles Method (String, String)

Returns the names of files in the specified directory that match the specified search pattern.

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

Visual Basic (Declaration)
Public Shared Function GetFiles ( _
    path As String, _
    searchPattern As String _
) As String()
Visual Basic (Usage)
Dim path As String
Dim searchPattern As String
Dim returnValue As String()

returnValue = Directory.GetFiles(path, _
    searchPattern)
C#
public static string[] GetFiles(
    string path,
    string searchPattern
)
Visual C++
public:
static array<String^>^ GetFiles(
    String^ path, 
    String^ searchPattern
)
JScript
public static function GetFiles(
    path : String, 
    searchPattern : String
) : String[]

Parameters

path
Type: System..::.String
The directory to search.
searchPattern
Type: System..::.String
The search string to match against the names of files in path. The parameter cannot end in two periods ("..") or contain two periods ("..") followed by DirectorySeparatorChar or AltDirectorySeparatorChar, nor can it contain any of the characters in InvalidPathChars.

Return Value

Type: array<System..::.String>[]()[]
A String array containing the names of files in the specified directory that match the specified search pattern.
Exceptions

ExceptionCondition
IOException

path is a file name.

-or-

A network error has occurred.

UnauthorizedAccessException

The caller does not have the required permission.

ArgumentException

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

-or-

searchPattern does not contain a valid pattern.

ArgumentNullException

path or searchPattern is nullNothingnullptra null reference (Nothing in Visual Basic).

PathTooLongException

The specified path, file name, or both 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.

DirectoryNotFoundException

The specified path is invalid (for example, it is on an unmapped drive).

Remarks

The returned file names are appended to the supplied path parameter.

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

The order of the returned file names is not guaranteed; use the Sort()()() method if a specific sort order is required.

The following wildcard specifiers are permitted in searchPattern.

Wildcard character

Description

*

Zero or more characters.

?

Exactly zero or one character.

Characters other than the wildcard specifiers represent themselves. 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".

NoteNote:

When using the asterisk wildcard character in a searchPattern, such as "*.txt", the matching behavior when the extension is exactly three characters long is different than when the extension is more or less than three characters long. A searchPattern with a file extension of exactly three characters returns files having 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 having 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, "file1.txt" and "file1.txtother", in a directory, a search pattern of "file?.txt" returns just 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.

NoteNote:

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 path parameter is permitted to 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 GetCurrentDirectory.

The path parameter is not case-sensitive.

For a list of common I/O tasks, see Common I/O Tasks.

Examples

The following code example counts the number of files that begin with the specified letter.

Visual Basic
Imports System
Imports System.IO

Public Class Test
    Public Shared Sub Main()
        Try
            ' Only get files that begin with the letter "c."
            Dim dirs As String() = Directory.GetFiles("c:\", "c*")
            Console.WriteLine("The number of files starting with c is {0}.", dirs.Length)
            Dim dir As String
            For Each dir In dirs
                Console.WriteLine(dir)
            Next
        Catch e As Exception
            Console.WriteLine("The process failed: {0}", e.ToString())
        End Try
    End Sub
End Class
C#
using System;
using System.IO;

class Test 
{
    public static void Main() 
    {
        try 
        {
            // Only get files that begin with the letter "c."
            string[] dirs = Directory.GetFiles(@"c:\", "c*");
            Console.WriteLine("The number of files starting with c is {0}.", dirs.Length);
            foreach (string dir in dirs) 
            {
                Console.WriteLine(dir);
            }
        } 
        catch (Exception e) 
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    }
}
Visual C++
using namespace System;
using namespace System::IO;
int main()
{
   try
   {

      // Only get files that begin with the letter "c."
      array<String^>^dirs = Directory::GetFiles( "c:\\", "c*" );
      Console::WriteLine( "The number of files starting with c is {0}.", dirs->Length );
      Collections::IEnumerator^ myEnum = dirs->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         Console::WriteLine( myEnum->Current );
      }
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "The process failed: {0}", e );
   }

}

.NET Framework Security

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

Other Resources

Tags :


Community Content

sbrickey
Example for multiple search filters?
Does anyone have an example for searching with multiple filters? (*.txt, *.doc).
Tags :

Thomas Lee
Multiple Filters
I also need an example of the above, searching for multiple filters.
Tags :

Hamdy.Ghanem
fix Multiple Filters

public static FileInfo[] MultipleFileFilter(DirectoryInfo dirInfo, string validExtensions)
{
//create a string array of our filters by plitting the
//string of valid filters on the delimiter
string[] extFilter = validExtensions.Split(new char[] { ',' });

//ArrayList to hold the files with the certain extensions
ArrayList files = new ArrayList();

//loop through each extension in the filter
foreach (string extension in extFilter)
{
//add all the files that match our valid extensions
//by using AddRange of the ArrayList
files.AddRange(dirInfo.GetFiles(extension));
}
FileInfo[] fs = new FileInfo[files.Count];
for (int i = 0; i < files.Count; i++)
{
fs[i] = (FileInfo)files[i];
}
return fs;

}





use it like this

MultipleFileFilter(diSource,"*.png,*jpg,*gif")

Oix
Multiple Filters

using System.Linq;

DirectoryInfo dir = newDirectoryInfo(@"d:\Films");

FileInfo[] infos1 = dir.GetFiles("*.avi", SearchOption.AllDirectories);

FileInfo[] infos2 = dir.GetFiles("*.mpg", SearchOption.AllDirectories);

FileInfo[] infos = infos1.Union(infos2).ToArray();

foreach(FileInfo info in infos)

{

string fileName = info.Name;

}

Tags :

dual_barrel
Multiple File Extension check!

using System.Linq;

foreach (string f in Directory.GetFiles(@"C:\"))

{

if (string.Compare(Path.GetExtension(f), ".txt") == 0 || string.Compare(Path.GetExtension (f), ".doc") == 0 )
{
//Your logic, i.e., what you wanna do as the file extension has matched!
}

}


JMitchem
A slightly more 'elegant' solution for multiple extensions
using System.Linq;


string folder = @"C:\Projects";

IEnumerable<string> fileNames =
Directory.GetFiles( folder ).Where(
f => f.EndsWith( ".vb" )
|| f.EndsWith( ".xml" )
|| f.EndsWith( ".aspx" )
|| f.EndsWith( ".ascx" )
|| f.EndsWith( ".asax" )
|| f.EndsWith( ".config" )
);


foreach( var fileName in fileNames )
{
// etc.
}

Tags :

bert eats dirt
Broken three letter extension search
Is there any easy way to get around the ridiculous "feature" of returning all files whose extension begins with the three letter extension being searched for? (If I wanted any files whose extension began with ".abc" I'd search for ".abc*", which is the logical and consistent thing to do)
Tags : whinge

BrianLedsworth
When using EndsWith, be sure to include a CaseInsesntive System.StringComparison

I add a StringComparison so files with mixed or all uppcer case extensions are not filtered, as in the following example, which would exclude .SQL w/o the StringComparison.OrdinalIgnoreCase

if (file.Name.EndsWith(".sql", System.StringComparison.OrdinalIgnoreCase))



Tags :

Page view tracker