Click or drag to resize

VGMembershipInstanceDeleteUser Method (String, Boolean)

Note: This API is now obsolete.

Deletes a user from the repository.

Namespace:  Novalys.VisualGuard.Security.Membership
Assembly:  Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2019.1.831.19 (2019.1.0831.19)
Syntax
Copy
[ObsoleteAttribute("Use DeleteUser(VGMembershipUser user)")]
public bool DeleteUser(
	string username,
	bool forAllApplications
)

Parameters

username
Type: SystemString
The name of the user to delete.
forAllApplications
Type: SystemBoolean
true if the user must be deleted even the user is a member of another application, false otherwise

Return Value

Type: Boolean
true if the user was deleted; otherwise, false.
Exceptions
ExceptionCondition
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.
ArgumentNullExceptionusername is null.
ArgumentExceptionusername is empty or is longer than 64 characters or contains invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ',').
SecurityExceptionThe current user does not have 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