Server.EnumWindowsGroupInfo Method (String, Boolean)

Enumerates a list of information about all Microsoft Windows groups that have explicitly granted access to the instance of SQL Server and with the option to list the individual members.

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

Syntax

'Declaration
Public Function EnumWindowsGroupInfo ( _
    group As String, _
    listMembers As Boolean _
) As DataTable
'Usage
Dim instance As Server
Dim group As String
Dim listMembers As Boolean
Dim returnValue As DataTable

returnValue = instance.EnumWindowsGroupInfo(group, _
    listMembers)
public DataTable EnumWindowsGroupInfo(
    string group,
    bool listMembers
)
public:
DataTable^ EnumWindowsGroupInfo(
    String^ group, 
    bool listMembers
)
member EnumWindowsGroupInfo : 
        group:string * 
        listMembers:bool -> DataTable 
public function EnumWindowsGroupInfo(
    group : String, 
    listMembers : boolean
) : DataTable

Parameters

  • group
    Type: System.String
    A String value that specifies a Windows group on which to limit the results.
  • listMembers
    Type: System.Boolean
    A Boolean value that specifies whether to list the members of the Windows group that has been granted access to the instance of SQL Server.
    If True, the individual members are listed.
    If False, the individual members are not listed.

Return Value

Type: System.Data.DataTable

A DataTable system object value that contains a list of Windows groups that have explicitly granted access to the instance of SQL Server. The table describes the different columns of the returned DataTable.

Column

Data type

Description

account name

String

The name of the Windows NT user. NT AUTHORITY\SYSTEM, for example.

type

String

The type of user. This specifies whether the user is an individual account or a group account.

privilege

String

The privilege level assigned to the Windows NT group.

mapped login name

String

The SQL Server login account to which the Windows NT group is mapped.

permission path

String

The permission path for the Windows NT group.