Visual Guard Class Library Documentation

VGRoles.IsUserInRole Method (String, String)

Gets a value indicating whether the specified user is in the specified role.

public static bool IsUserInRole(
   String username,
   String roleName
);

Parameters

username
The name of the user to search for.
roleName
The name of the role to search in.

Return Value

true if the specified user is in the specified role; otherwise, false.

Exceptions

Exception Type Condition
ArgumentNullException roleName is null.

-or-

username is null.
ArgumentException roleName is an empty string or is longer than 64 characters.

-or-

username is an empty string or is longer than 64 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

VGRoles Class | Novalys.VisualGuard.Security.Membership Namespace | VGRoles.IsUserInRole Overload List