Database.EnumObjectPermissions Method (ObjectPermissionSet)

Article
12/03/2008

Enumerates a list of permissions for objects in the database limited to the specified permission set.

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

Syntax

'Declaration
Public Function EnumObjectPermissions ( _
    permissions As ObjectPermissionSet _
) As ObjectPermissionInfo()

public ObjectPermissionInfo[] EnumObjectPermissions (
    ObjectPermissionSet permissions
)

public:
array<ObjectPermissionInfo^>^ EnumObjectPermissions (
    ObjectPermissionSet^ permissions
)

public ObjectPermissionInfo[] EnumObjectPermissions (
    ObjectPermissionSet permissions
)

public function EnumObjectPermissions (
    permissions : ObjectPermissionSet
) : ObjectPermissionInfo[]

Parameters

permissions
A ObjectPermissionSet object that limits the enumerated list to those listed.

Return Value

An array of ObjectPermissionInfo objects that contains a list of object permissions for the database.

Remarks

Updated text:17 July 2006

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

The example shows the EnumServerPermissions method, which is used in the same way as the EnumObjectPermissions method.

'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