Deletes a user specified by its repository id from the repository.

Namespace:  Novalys.VisualGuard.Security.Membership
Assembly:  Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 3.2.912.1 (3.2.912.01)

Syntax

C#
public static bool DeleteUserById(
	string userId,
	bool forAllApplications
)
Visual Basic (Declaration)
Public Shared Function DeleteUserById ( _
	userId As String, _
	forAllApplications As Boolean _
) As Boolean

Parameters

userId
Type: System..::.String
The repository id of the user to delete.
forAllApplications
Type: System..::.Boolean
true if the user must be deleted even the user is a member of another application, false otherwise

Return Value

true if the user was deleted; otherwise, false.

Exceptions

ExceptionCondition
Novalys.VisualGuard.Security.Membership..::.VGIsMemberOfAnotherApplicationExceptionThe user is a member of an another application and the forAllApplications not equal to true. -or- The user is a master administrator of the console.
System..::.ArgumentNullException userId is null.
System..::.ArgumentException userId is empty or is longer than 256 characters.
System.Security..::.SecurityExceptionThe current user has not enough privileges to use Membership API. The Membership access level of the application must be sufficient to allows this action or the 'Membership Manager' role must be granted to the user by using the Visual Guard console.

See Also