Server.IsWindowsGroupMember Method

Article
12/03/2008

Verifies whether the specified Microsoft Windows user account is a member of the specified Windows group.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Function IsWindowsGroupMember ( _
    windowsGroup As String, _
    windowsUser As String _
) As Boolean

public bool IsWindowsGroupMember (
    string windowsGroup,
    string windowsUser
)

public:
bool IsWindowsGroupMember (
    String^ windowsGroup, 
    String^ windowsUser
)

public boolean IsWindowsGroupMember (
    String windowsGroup, 
    String windowsUser
)

public function IsWindowsGroupMember (
    windowsGroup : String, 
    windowsUser : String
) : boolean

Parameters

windowsGroup
A String value that specifies the Windows group.

windowsUser
A String value that specifies the Windows user account.

Return Value

A Boolean value that specifies whether the Windows user account is a member of the Windows group. If True, the Windows user account is a member of the Windows group. If False, the Windows user account is not a member of the Windows group.

Remarks

Updated text:

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Verify whether a Windows user is a member of a Windows group.
Console.WriteLine(srv.IsWindowsGroupMember( _
"BUILTIN\Administrators", "NT AUTHORITY\SYSTEM").ToString)

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms