FileSystem.GetAttr(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
public:
static Microsoft::VisualBasic::FileAttribute GetAttr(System::String ^ PathName);
public static Microsoft.VisualBasic.FileAttribute GetAttr (string PathName);
static member GetAttr : string -> Microsoft.VisualBasic.FileAttribute
Public Function GetAttr (PathName As String) As FileAttribute
Parameters
- PathName
- String
Required. A string expression that specifies a file, directory, or folder name. PathName
can include the directory or folder, and the drive.
Returns
A bitwise combination of the enumeration values.
Exceptions
Pathname
is invalid or contains wildcards.
Target file does not exist.
Examples
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
Remarks
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.