This documentation is archived and is not being maintained.

WindowsPrincipal.IsInRole Method (SecurityIdentifier)

Determines whether the current principal belongs to the Windows user group that has the specified security identifier (SID).

Namespace:  System.Security.Principal
Assembly:  mscorlib (in mscorlib.dll)

[ComVisibleAttribute(false)]
public virtual bool IsInRole(
	SecurityIdentifier sid
)

Parameters

sid
Type: System.Security.Principal.SecurityIdentifier
An object that uniquely identifies a Windows user group.

Return Value

Type: System.Boolean
true if the current principal is a member of the specified Windows user group; otherwise, false.

ExceptionCondition
ArgumentNullException

sid is null.

SecurityException

Windows returned a Win32 error.

The SecurityIdentifier uniquely identifies a user or group on Windows 2000, Windows Server, and Windows XP implementations. When testing for newly created role information, such as a new user or a new group, you should log out and log back in to force the propagation of role information within the domain. Not doing so can cause the IsInRole test to return false.

NoteNote

In Windows Vista and later versions of the Windows operating system, User Account Control (UAC) determines the privileges of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. When you attempt to perform a task that requires administrative privileges, you can dynamically elevate your role by using the Consent dialog box. The code that executes the IsInRole method does not display the Consent dialog box. The code returns false if you are in the standard user role or in the Built-in Administrators group. You can elevate your privileges before you execute the code by right-clicking the application icon and indicating that you want to run as an administrator.

For performance reasons, this is the preferable overload to determine a user's role.

The following example demonstrates the use of the WindowsPrincipal.IsInRole(SecurityIdentifier) method. The BuiltinAdministratorsSid enumeration value is used to determine whether the current principal is an administrator. For the full code example, see the WindowsPrincipal.IsInRole(Int32) method.


// Get the role using the WellKnownSidType.
SecurityIdentifier sid = new SecurityIdentifier(WellKnownSidType.BuiltinAdministratorsSid, null);
Console.WriteLine("WellKnownSidType BuiltinAdministratorsSid  {0}? {1}.", sid.Value, myPrincipal.IsInRole(sid));


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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