userInGroup

Owned by Jonathan Muse
Last updated: Nov 19, 2024
1 min read

Description

Verifies if the selected user is in the selected group(s).

Parameters

Return Type

Boolean

A "true" return value means that the user associated with the specified username or userkey belongs to the given group(s).

Examples

Example 1

userInGroup("Administrators", "Admin1");

Returns "true" if Admin1 is included in Administrators group and "false" if Admin1 is not included in Administrators group.

Example 2

userInGroup("Users", currentUser());

Returns: True if the current user is included in "Users" group or False if the current user is not included in "Users" group.

Example 3

string[] groups = {"Administrators", "Users"}; userInGroup(groups, currentUser());

Returns "true" if the current user is included in Users or Administrators group and "false" if the current user is not included neither in Users nor in Administrators group.

The look -up is first made after the userkey, then after the username.

See also

Peacock