Gets a list of speciales roles that a user is in.
Namespace: Novalys.VisualGuard.Security.MembershipAssembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2017.0.101.17 (2017.0.101.17)
Syntax
C# |
---|
[ObsoleteAttribute("Use GetSpecialRolesCollectionForUser(VGMembershipUser user) method")] public VGRoleId[] GetSpecialRolesForUser( string username, VGAuthenticationMode mode ) |
Visual Basic |
---|
<ObsoleteAttribute("Use GetSpecialRolesCollectionForUser(VGMembershipUser user) method")> Public Function GetSpecialRolesForUser ( username As String, mode As VGAuthenticationMode ) As VGRoleId() |
Parameters
- username
- Type: System..::..String
The user to return a list of roles for.
- mode
- Type: Novalys.VisualGuard.Security..::..VGAuthenticationMode
the mode of authentication of the user.
Return Value
Type: array<VGRoleId>[]()[][]A VGRoleId array containing the names of all the roles that the specified user is in.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentException | username 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. |
System..::..ArgumentNullException | username is null. |
System.Security..::..SecurityException | The 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. |