Server.IsWindowsGroupMember Method (String, String)

Article
07/16/2015

Applies To: SQL Server 2016 Preview

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

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 As String,
    windowsUser As String
) As 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

Legacy Code Example

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