Click or drag to resize

VGRolesInstanceGetSpecialRolesForUser Method (String, VGAuthenticationMode)

Note: This API is now obsolete.

Gets a list of speciales roles that a user is in.

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 GetSpecialRolesCollectionForUser(VGMembershipUser user) method")]
public VGRoleId[] GetSpecialRolesForUser(
	string username,
	VGAuthenticationMode mode
)

Parameters

username
Type: SystemString
The user to return a list of roles for.
mode
Type: Novalys.VisualGuard.SecurityVGAuthenticationMode
the mode of authentication of the user.

Return Value

Type: VGRoleId
A VGRoleId array containing the names of all the roles that the specified user is in.
Exceptions
ExceptionCondition
ArgumentExceptionusername is empty or longer than 64 characters or contains invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ',') for Visual Guard account.

-or-

username cannot be converted to SID for Windows Account.

-or-

mode is not equal to Windows or VisualGuard or Database or is a combination of several values.
ArgumentNullExceptionusername is null.
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