Server.EnumServerPermissions Method (String, ServerPermissionSet)
Enumerates a list of server permissions for a specified grantee and a specified permission on the instance of Microsoft SQL Server.
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)
Syntax
'Declaration
Public Function EnumServerPermissions ( _
granteeName As String, _
permissions As ServerPermissionSet _
) As ServerPermissionInfo()
public ServerPermissionInfo[] EnumServerPermissions (
string granteeName,
ServerPermissionSet permissions
)
public:
array<ServerPermissionInfo^>^ EnumServerPermissions (
String^ granteeName,
ServerPermissionSet^ permissions
)
public ServerPermissionInfo[] EnumServerPermissions (
String granteeName,
ServerPermissionSet permissions
)
public function EnumServerPermissions (
granteeName : String,
permissions : ServerPermissionSet
) : ServerPermissionInfo[]
Parameters
- granteeName
A String value that specifies the grantee.
- permissions
A ServerPermissionSet object value that specifies the permission.
Return Value
An array of ServerPermissionInfo objects that contains server permission information for the specified grantee and permission on the instance of SQL Server.
Remarks
Updated text:
Use this method to return an array of ServerPermissionInfo objects that contain information about the permissions currently set on the instance of SQL Server for the specified grantee and for the given set of permissions.
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 svr As Server
svr = New Server()
'Define a ServerPermissionSet that contains permission to Create Endpoint and Alter Any Endpoint.
Dim sps As ServerPermissionSet
sps = New ServerPermissionSet(ServerPermission.CreateEndpoint)
sps.Add(ServerPermission.AlterAnyEndpoint)
'This sample assumes that the grantee already has permission to Create Endpoints.
'Enumerate and display the server permissions in the set for the grantee specified in the vGrantee string variable.
Dim spis As ServerPermissionInfo()
spis = svr.EnumServerPermissions(vGrantee, sps)
Dim spi As ServerPermissionInfo
Console.WriteLine("=================Before revoke===========================")
For Each spi In spis
Console.WriteLine(spi.Grantee & " has " & spi.PermissionType.ToString & " permission.")
Next
Console.WriteLine(" ")
'Remove a permission from the set.
sps.Remove(ServerPermission.CreateEndpoint)
'Revoke the create endpoint permission from the grantee.
svr.Revoke(sps, vGrantee)
'Enumerate and display the server permissions in the set for the grantee specified in the vGrantee string variable.
spis = svr.EnumServerPermissions(vGrantee, sps)
Console.WriteLine("=================After revoke============================")
For Each spi In spis
Console.WriteLine(spi.Grantee & " has " & spi.PermissionType.ToString & " permission.")
Next
Console.WriteLine(" ")
'Grant the Create Endpoint permission to the grantee.
svr.Grant(sps, vGrantee)
'Enumerate and display the server permissions in the set for the grantee specified in the vGrantee string variable.
spis = svr.EnumServerPermissions(vGrantee, sps)
Console.WriteLine("=================After grant=============================")
For Each spi In spis
Console.WriteLine(spi.Grantee & " has " & spi.PermissionType.ToString & " permission.")
Next
Console.WriteLine("")
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
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
See Also
Reference
Server Class
Server Members
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
How to: Grant Server Permissions in Visual Basic .NET
Calling Methods
Managing Servers
Change History
Release |
History |
New content:
|