Visual Guard Class Library Documentation

VGMembership.DeleteUserById Method

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

public static bool DeleteUserById(
String userId,
Boolean forAllApplications
);

Parameters

userId: The repository id of the user to delete.
forAllApplications: 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

Exception Type	Condition
VGIsMemberOfAnotherApplicationException	The 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.
ArgumentNullException	userId is null.
ArgumentException	userId is empty or is longer than 256 characters.
SecurityException	The 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

VGMembership Class | Novalys.VisualGuard.Security.Membership Namespace