VGRoles.FindUsersInRole Method

Gets a list of users in a specified role where the user name contains the specified user name to match.

public static string[] FindUsersInRole(
String roleName,
String usernameToMatch
);

Parameters

roleName: The role to search in. For shared role the value must be prefixed by '#'.
usernameToMatch: The user name to search for.

Return Value

A string array containing the names of all the users whose user name matches usernameToMatch and who are members of the specified role.

Remarks

Wildcards such as asterisks and question marks can be used in the usernameToMatch parameter value.

Exceptions

Exception Type	Condition
ArgumentNullException	roleName is null (Nothing in Visual Basic). -or- usernameToMatch is null.
ArgumentException	roleName is an empty string or contains invalid invalid chars ('\', '/', '?', '', '%', ';', ''', '"', ':', '\|', '[', ']', '+', '=', ',') or is longer than 64 characters. -or- role identified by roleName* does not exists in the repository. -or- usernameToMatch is an empty string.

Exception Type

Condition

ArgumentNullException

roleName is null (Nothing in Visual Basic).

-or-

usernameToMatch is null.

ArgumentException

roleName is an empty string or contains invalid invalid chars ('\', '/', '?', '*', '%', ';', ''', '"', ':', '|', '[', ']', '+', '=', ',') or is longer than 64 characters.

-or-

role identified by roleName does not exists in the repository.

-or-

usernameToMatch is an empty string.

VGRoles.FindUsersInRole Method

Parameters

Return Value

Remarks

Exceptions

See Also