SPRoleDefinitionCollection.Delete method (Int32)

  • Article

Deletes the role definition at the specified index in the collection.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Sub Delete ( _
    indexer As Integer _
)
'Usage
Dim instance As SPRoleDefinitionCollection
Dim indexer As Integer

instance.Delete(indexer)

public void Delete(
    int indexer
)

Parameters

  • indexer
    Type: System.Int32

    A 32-bit integer that specifies the index.

Exceptions

Exception Condition
ArgumentException

The role definition of the current website is not inherited from the parent website.

-or-

The current website does not have the unique role definition.
SPException

The type of the role definition that specified the indexer parameter is guest or administrator.

Remarks

The Delete method unbinds and destroys the data of the role definition, deleting all role assignment bindings for the definition. For example, if the roles Contribute and Author have been assigned to a user and the Author role definition is deleted, the user will have only the Contribute role.

See also

Reference

SPRoleDefinitionCollection class

SPRoleDefinitionCollection members

Delete overload

Microsoft.SharePoint namespace