Server.IsWindowsGroupMember Method

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
'Usage
Dim instance As Server 
Dim windowsGroup As String 
Dim windowsUser As String 
Dim returnValue As Boolean 

returnValue = instance.IsWindowsGroupMember(windowsGroup, _
    windowsUser)

public bool IsWindowsGroupMember(
    string windowsGroup,
    string windowsUser
)

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

member IsWindowsGroupMember : 
        windowsGroup:string * 
        windowsUser:string -> bool

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

Parameters

• windowsGroup
  Type: System.String
  A String value that specifies the Windows group.

• windowsUser
  Type: System.String
  A String value that specifies the Windows user account.

Return Value

Type: System.Boolean
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.

Examples

Visual Basic

'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)

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")

Write-Host $srv.IsWindowsGroupMember("BUILTIN\Administrators", "NT AUTHORITY\SYSTEM")

See Also

Reference

Server Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Calling Methods

Managing Servers