Directory::EnumerateDirectories Method (String^)

.NET Framework (current version)

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

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

Syntax

public:
static IEnumerable<String^>^ EnumerateDirectories(
	String^ path
)

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<String^>^

An enumerable collection of the full names (including paths) for the directories in the directory specified by path.

Exceptions

Exception	Condition
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 null.
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 or absolute path information in 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 returned directory names are prefixed with the value you provided in the path parameter. For example, if you provide a relative path in the path parameter, the returned directory names will contain a relative path.

The EnumerateDirectories and GetDirectories methods differ as follows: When you use EnumerateDirectories, you can start enumerating the collection of names before the whole collection is returned; when you use GetDirectories, 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, EnumerateDirectories can be more efficient.

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

Examples

The following example enumerates the top-level directories in a specified path.

C++

No code example is currently available or this language may not be supported.

Version Information

Universal Windows Platform
Available since 10
.NET Framework
Available since 4.0
Silverlight
Available since 4.0