FileSystem.SetAttr(String, FileAttribute) Method

Reference

Definition

Namespace:: Microsoft.VisualBasic

Assembly:: Microsoft.VisualBasic.Core.dll

Assembly:: Microsoft.VisualBasic.dll

Source:: FileSystem.vb

Source:: FileSystem.vb

Source:: FileSystem.vb

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.

Sets attribute information for a file. The My feature gives you better productivity and performance in file I/O operations than SetAttr. For more information, see FileSystem.

public:
 static void SetAttr(System::String ^ PathName, Microsoft::VisualBasic::FileAttribute Attributes);

public static void SetAttr (string PathName, Microsoft.VisualBasic.FileAttribute Attributes);

static member SetAttr : string * Microsoft.VisualBasic.FileAttribute -> unit

Public Sub SetAttr (PathName As String, Attributes As FileAttribute)

Parameters

PathName: String

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

Attributes: FileAttribute

Required. Constant or numeric expression, whose sum specifies file attributes.

Exceptions

ArgumentException

Attribute type is invalid.

Examples

This example uses the SetAttr function to set attributes for a file.

' Set hidden attribute.
SetAttr("TESTFILE", vbHidden)
' Set hidden and read-only attributes.
SetAttr("TESTFILE", vbHidden Or vbReadOnly)

Remarks

A run-time error occurs if you try to set the attributes of an open file.

The Attributes argument enumeration values are as follows:

Value	Constant	Description
`Normal`	`vbNormal`	Normal (default).
`ReadOnly`	`vbReadOnly`	Read-only.
`Hidden`	`vbHidden`	Hidden.
`System`	`vbSystem`	System file.
`Volume`	`vbVolume`	Volume label
`Directory`	`vbDirectory`	Directory or folder.
`Archive`	`vbArchive`	File has changed since last backup.
`Alias`	`vbAlias`	File has a different name.

Note

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

Applies to