Server.EnumWindowsGroupInfo Method (String, Boolean)

Article
12/03/2008

Enumerates a list of information about all Microsoft Windows groups that have explicitly granted access to the instance of Microsoft 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

public DataTable EnumWindowsGroupInfo (
    string group,
    bool listMembers
)

public:
DataTable^ EnumWindowsGroupInfo (
    String^ group, 
    bool listMembers
)

public DataTable EnumWindowsGroupInfo (
    String group, 
    boolean listMembers
)

public function EnumWindowsGroupInfo (
    group : String, 
    listMembers : boolean
) : DataTable

Parameters

group
A String value that specifies a Windows group on which to limit the results.

listMembers
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

Updated text: 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.

Remarks

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
'Call the EnumCollations method and return collation information to DataTable variable.
Dim d As DataTable
'Select the returned data into an array of DataRow.
d = srv.EnumCollations
'Iterate through the rows and display collation details for the instance of SQL Server.
Dim r As DataRow
Dim c As DataColumn
For Each r In d.Rows
    Console.WriteLine("============================================")
    For Each c In r.Table.Columns
        Console.WriteLine(c.ColumnName + " = " + r(c).ToString)
    Next
Next

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