Share via


SPClaimsAuthMembershipProvider.DeleteUser method

Removes a user from the data source.

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

Syntax

'Declaration
Public Overrides Function DeleteUser ( _
    name As String, _
    deleteAllRelatedData As Boolean _
) As Boolean
'Usage
Dim instance As SPClaimsAuthMembershipProvider
Dim name As String
Dim deleteAllRelatedData As Boolean
Dim returnValue As Boolean

returnValue = instance.DeleteUser(name, _
    deleteAllRelatedData)
public override bool DeleteUser(
    string name,
    bool deleteAllRelatedData
)

Parameters

  • deleteAllRelatedData
    Type: System.Boolean

    true to delete all of the data related to the user from the data store; false to leave the data related to the user in the data store.

Return value

Type: System.Boolean
true if the user is deleted successfully; otherwise, false.

Remarks

This override removes a user from the data source in the membership provider that is not an SPClaimsAuthMembershipProvider, and is used by forms-based authentication in the current application.

See also

Reference

SPClaimsAuthMembershipProvider class

SPClaimsAuthMembershipProvider members

Microsoft.SharePoint.Administration.Claims namespace