Dir Method (String, FileAttribute)
Collapse the table of content
Expand the table of content

FileSystem.Dir Method (String, FileAttribute)

 

Returns a string representing the name of a file, directory, or folder that matches a specified pattern or file attribute, or the volume label of a drive. The FileSystem gives you better productivity and performance in file I/O operations than the Dir function. See GetDirectoryInfo for more information.

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public static string Dir(
	string PathName,
	FileAttribute Attributes = FileAttribute.Normal
)

Parameters

PathName
Type: System.String

Optional. String expression that specifies a file name, directory or folder name, or drive volume label. A zero-length string ("") is returned if PathName is not found.

Attributes
Type: Microsoft.VisualBasic.FileAttribute

Optional. Enumeration or numeric expression whose value specifies file attributes. If omitted, Dir returns files that match PathName but have no attributes.

Return Value

Type: System.String

A string representing the name of a file, directory, or folder that matches a specified pattern or file attribute, or the volume label of a drive.

The Dir function supports the use of multiple-character (*) and single-character (?) wildcards to specify multiple files.

VbVolume returns the volume label for the drive instead of a specific file name.

You must supply a PathName the first time that you call the Dir function. To retrieve the next item, you can make subsequent calls to the Dir function with no parameters.

System_CAPS_security Security Note

To run correctly, the Dir function requires the Read and PathDiscoveryflags of FileIOPermission to be granted to the executing code. For more information, see FileIOPermission, SecurityException, and Code Access Permissions.

The Attributes argument enumeration values are as follows:

Value

Constant

Description

Normal

vbnormal

Default. Specifies files that have no attributes.

ReadOnly

vbReadOnly

Specifies read-only files, in addition to files that have no attributes.

Hidden

vbHidden

Specifies hidden files, in addition to files that have no attributes.

System

vbSystem

Specifies system files, in addition to files that have no attributes.

Volume

vbVolume

Specifies volume label; if any other attribute is specified, vbVolume is ignored.

Directory

vbDirectory

Specifies directories or folders, in addition to files that have no attributes.

Archive

vbArchive

File has changed since last backup.

Alias

vbAlias

File has a different name.

System_CAPS_noteNote

These enumerations are specified by the Visual Basic language and can be used anywhere in your code in place of the actual values.

This example uses the Dir function to check if certain files and directories exist.

Dim MyFile, MyPath, MyName As String
' Returns "WIN.INI" if it exists.
MyFile = Dir("C:\WINDOWS\WIN.INI")

' Returns filename with specified extension. If more than one *.INI
' file exists, the first file found is returned.
MyFile = Dir("C:\WINDOWS\*.INI")

' Call Dir again without arguments to return the next *.INI file in the
' same directory.
MyFile = Dir()

' Return first *.TXT file, including files with a set hidden attribute.
MyFile = Dir("*.TXT", vbHidden)

' Display the names in C:\ that represent directories.
MyPath = "c:\"   ' Set the path.
MyName = Dir(MyPath, vbDirectory)   ' Retrieve the first entry.
Do While MyName <> ""   ' Start the loop.
    ' Use bitwise comparison to make sure MyName is a directory.
    If (GetAttr(MyPath & MyName) And vbDirectory) = vbDirectory Then
        ' Display entry only if it's a directory.
        MsgBox(MyName)
    End If
    MyName = Dir()   ' Get next entry.
Loop

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft