Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

FileAttributes Enumeration

Provides attributes for files and directories.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

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

[SerializableAttribute]
[FlagsAttribute]
[ComVisibleAttribute(true)]
public enum FileAttributes

Member nameDescription
Supported by the XNA FrameworkArchiveThe file is a candidate for backup or removal.
Supported by the XNA FrameworkCompressedThe file is compressed.
Supported by the XNA FrameworkDeviceReserved for future use.
Supported by the XNA FrameworkDirectoryThe file is a directory.
Supported by the XNA FrameworkEncryptedThe file or directory is encrypted. For a file, this means that all data in the file is encrypted. For a directory, this means that encryption is the default for newly created files and directories.
Supported by the XNA FrameworkHiddenThe file is hidden, and thus is not included in an ordinary directory listing.
IntegrityStreamThe file or directory includes data integrity support. When this value is applied to a file, all data streams in the file have integrity support. When this value is applied to a directory, all new files and subdirectories within that directory, by default, include integrity support.
Supported by the XNA FrameworkNormalThe file is a standard file that has no special attributes. This attribute is valid only if it is used alone.
NoScrubDataThe file or directory is excluded from the data integrity scan. When this value is applied to a directory, by default, all new files and subdirectories within that directory are excluded from data integrity.
Supported by the XNA FrameworkNotContentIndexedThe file will not be indexed by the operating system's content indexing service.
Supported by the XNA FrameworkOfflineThe file is offline. The data of the file is not immediately available.
Supported by the XNA FrameworkReadOnlyThe file is read-only.
Supported by the XNA FrameworkReparsePointThe file contains a reparse point, which is a block of user-defined data associated with a file or a directory.
Supported by the XNA FrameworkSparseFileThe file is a sparse file. Sparse files are typically large files whose data consists of mostly zeros.
Supported by the XNA FrameworkSystemThe file is a system file. That is, the file is part of the operating system or is used exclusively by the operating system.
Supported by the XNA FrameworkTemporaryThe file is temporary. A temporary file contains data that is needed while an application is executing but is not needed after the application is finished. File systems try to keep all the data in memory for quicker access rather than flushing the data back to mass storage. A temporary file should be deleted by the application as soon as it is no longer needed.

You can get attributes for files and directories by calling the GetAttributes method, and you can set them by calling the SetAttributes method.

It is not possible to change the compression status of a File object by using the SetAttributes method. Instead, you must actually compress the file using either a compression tool or one of the classes in the System.IO.Compression namespace.

The following example shows how to retrieve the attributes for a file and check if the file is read-only.

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            FileAttributes attributes = File.GetAttributes("c:/Temp/testfile.txt");
            if ((attributes & FileAttributes.ReadOnly) == FileAttributes.ReadOnly)
            {
                Console.WriteLine("read-only file");
            }
            else
            {
                Console.WriteLine("not read-only file");
            }
        }
    }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft