DirectoryInfo::GetFileSystemInfos Method (String^)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Retrieves an array of strongly typed FileSystemInfo objects representing the files and subdirectories that match the specified search criteria.

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

public:
array<FileSystemInfo^>^ GetFileSystemInfos(
	String^ searchPattern
)

Parameters

searchPattern
Type: System::String^

The search string to match against the names of directories and files. 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.

Return Value

Type: array<System.IO::FileSystemInfo^>^

An array of strongly typed FileSystemInfo objects matching the search criteria.

Exception Condition
ArgumentException

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

ArgumentNullException

searchPattern is null.

DirectoryNotFoundException

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

SecurityException

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".

This method is not recursive.

For subdirectories, the FileSystemInfo objects returned by this method can be cast to the derived class DirectoryInfo. Use the FileAttributes value returned by the FileSystemInfo::Attributes property to determine whether the FileSystemInfo represents a file or a directory.

Wild cards are permitted. For example, the searchPattern string "*t" searches for all directory names in path ending with the letter "t". The searchPattern string "s*" searches for all directory names in path beginning with the letter "s".

The string ".." can only be used in searchPattern if it is specified as a part of a valid directory name, such as in the directory name "a..b". It cannot be used to move up the directory hierarchy. If there are no files or directories, or no files or directories that match the searchPattern string in the DirectoryInfo, this method returns an empty array.

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

The following example counts the files and directories that match the specified search pattern.

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 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: