Database.Revoke Method (DatabasePermissionSet, String[], Boolean, Boolean)

Article
12/03/2008

Revokes previously granted permissions from grantees on the database and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.

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

Syntax

'Declaration
Public Sub Revoke ( _
    permission As DatabasePermissionSet, _
    granteeNames As String(), _
    revokeGrant As Boolean, _
    cascade As Boolean _
)

public void Revoke (
    DatabasePermissionSet permission,
    string[] granteeNames,
    bool revokeGrant,
    bool cascade
)

public:
void Revoke (
    DatabasePermissionSet^ permission, 
    array<String^>^ granteeNames, 
    bool revokeGrant, 
    bool cascade
)

public void Revoke (
    DatabasePermissionSet permission, 
    String[] granteeNames, 
    boolean revokeGrant, 
    boolean cascade
)

public function Revoke (
    permission : DatabasePermissionSet, 
    granteeNames : String[], 
    revokeGrant : boolean, 
    cascade : boolean
)

Parameters

permission
A DatabasePermissionSet object value that specifies the set of permissions.

granteeNames
A String array that specifies a list of grantees to be revoked access to the set of permissions.

revokeGrant
A Boolean property that specifies whether the grantee is given the ability to revoke the specified set of permissions from other users on the database.

If True, the grantee is given the ability to revoke the specified set of permissions from other users on the database.

If False, the grantee is not given the ability to revoke the specified set of permissions from other users on the database.

cascade
A Boolean property that specifies whether users, to whom the grantee has granted the specified set of permissions, are also revoked the set of permissions.

If True, the grantee and users to whom the grantee granted the specified set of permission are all revoked the specified set of permissions on the database.

If False, only the grantee is revoked the specified set of permissions.

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 how to use the Revoke method with server permissions. The method is the same for database permissions.

'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.

Change History

Release	History
17 July 2006	Changed content: Added code to the Example section.