FileSystem.GetAttr 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.

Returns a FileAttribute value that represents the attributes of a file, directory, or folder. The My feature gives you better productivity and performance in file I/O operations than FileAttribute. For more information, see FileSystem.

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

public static FileAttribute GetAttr(
	string PathName
)

Parameters

PathName
Type: System.String

Required. String expression that specifies a file, directory, or folder name. PathName can include the directory or folder, and the drive.

Return Value

Type: Microsoft.VisualBasic.FileAttribute

The value returned by GetAttr is the sum of the following enumeration values:

Value

Constant

Description

Normal

vbNormal

Normal.

ReadOnly

vbReadOnly

Read-only.

Hidden

vbHidden

Hidden.

System

vbSystem

System file.

Directory

vbDirectory

Directory or folder.

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. The names can be used anywhere in your code in place of the actual values.

Exception Condition
IOException

Pathname is invalid or contains wildcards.

FileNotFoundException

Target file does not exist.

To determine which attributes are set, use the And operator to perform a bitwise comparison of the value returned by the GetAttr function and the value of the individual file attribute you want. If the result is not zero, that attribute is set for the named file. For example, the return value of the following And expression is zero if the Archive attribute is not set:

Result = GetAttr(FName) And vbArchive

A nonzero value is returned if the Archive attribute is set.

This example uses the GetAttr function to determine the attributes of a file and directory or folder.

Dim MyAttr As FileAttribute
' Assume file TESTFILE is normal and readonly.
MyAttr = GetAttr("C:\TESTFILE.txt")   ' Returns vbNormal.

' Test for normal.
If (MyAttr And FileAttribute.Normal) = FileAttribute.Normal Then
    MsgBox("This file is normal.")
End If

' Test for normal and readonly.
Dim normalReadonly As FileAttribute
normalReadonly = FileAttribute.Normal Or FileAttribute.ReadOnly
If (MyAttr And normalReadonly) = normalReadonly Then
    MsgBox("This file is normal and readonly.")
End If

' Assume MYDIR is a directory or folder.
MyAttr = GetAttr("C:\MYDIR")
If (MyAttr And FileAttribute.Directory) = FileAttribute.Directory Then
    MsgBox("MYDIR is a directory")
End If

.NET Framework
Available since 1.1
Return to top
Show: