Export (0) Print
Expand All

Directory.EnumerateFileSystemEntries Method (String)

Returns an enumerable collection of file names and directory names in a specified path.

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

'Declaration
Public Shared Function EnumerateFileSystemEntries ( _
	path As String _
) As IEnumerable(Of String)

Parameters

path
Type: System.String

The relative or absolute path to the directory to search. This string is not case-sensitive.

Return Value

Type: System.Collections.Generic.IEnumerable(Of String)
An enumerable collection of file-system entries in the directory specified by path.

ExceptionCondition
ArgumentException

path is a zero-length string, contains only white space, or contains invalid characters. You can query for invalid characters by using the GetInvalidPathChars method.

ArgumentNullException

path is Nothing.

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.

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.

The EnumerateFileSystemEntries and GetFileSystemEntries methods differ as follows: When you use EnumerateFileSystemEntries, you can start enumerating the collection of entries before the whole collection is returned; when you use GetFileSystemEntries, you must wait for the whole array of entries to be returned before you can access the array. Therefore, when you are working with many files and directories, EnumerateFiles can be more efficient.

The returned collection is not cached; each call to the GetEnumerator on the collection will start a new enumeration.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4
Show:
© 2015 Microsoft