File.GetAccessControl Method (String, AccessControlSections) (System.IO)

GetAccessControl Method (String, Ac...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

File..::.GetAccessControl Method (String, AccessControlSections)

Gets a FileSecurity object that encapsulates the specified type of access control list (ACL) entries for a particular file.

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

Syntax

Visual Basic (Declaration)

Public Shared Function GetAccessControl ( _
    path As String, _
    includeSections As AccessControlSections _
) As FileSecurity

Visual Basic (Usage)

Dim path As String
Dim includeSections As AccessControlSections
Dim returnValue As FileSecurity

returnValue = File.GetAccessControl(path, _
    includeSections)

public static FileSecurity GetAccessControl(
    string path,
    AccessControlSections includeSections
)

Visual C++

public:
static FileSecurity^ GetAccessControl(
    String^ path, 
    AccessControlSections includeSections
)

JScript

public static function GetAccessControl(
    path : String, 
    includeSections : AccessControlSections
) : FileSecurity

Parameters

path: Type: System..::.String
The path to a file containing a FileSecurity object that describes the file's access control list (ACL) information.

includeSections: Type: System.Security.AccessControl..::.AccessControlSections
One of the AccessControlSections values that specifies the type of access control list (ACL) information to receive.

Return Value

Type: System.Security.AccessControl..::.FileSecurity
A FileSecurity object that encapsulates the access control rules for the file described by the path parameter.

Exceptions

Exception	Condition
IOException	An I/O error occurred while opening the file.
SEHException	The path parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
SystemException	The file could not be found.
UnauthorizedAccessException	The path parameter specified a file that is read-only. -or- This operation is not supported on the current platform. -or- The path parameter specified a directory. -or- The caller does not have the required permission.

Remarks

Use the GetAccessControl method to retrieve the access control list (ACL) entries for a file.

An ACL describes individuals and/or groups who have, or do not have, rights to specific actions on the given file. For more information, see ACL Technology Overview and How to: Add or Remove Access Control List Entries.

In NTFS environments, ReadAttributes and ReadExtendedAttributes are granted to the user if the user has ListDirectory rights on the parent folder. To deny ReadAttributes and ReadExtendedAttributes, deny ListDirectory on the parent directory.

.NET Framework Security

FileIOPermission
for permission to read the access control list. Associated enumerations: NoAccess, View
Security action: Demand.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

File Class

File Members

GetAccessControl Overload

System.IO Namespace