Equinox Online Help - Language Reference - A to Z

Home

SetUserGroup

Applies to
SyntaxSetUserGroup [GroupName]
Action[Statement] Changes the user group for the current user at runtime.
ScopeUsable anywhere.
Notes

This statement changes the user group for the current user, to the group specified by the parameter GroupName. If the parameter is omitted, the group is reset to the one that was used when the user logged in. To de-assign a user group for the current user (ie to specify no user group) use an empty string (a pair of double-quotes) as the argument (""). You can also use the following special arguments:

  • DefaultUserGroup Specify the default user group
  • BlankUserGroup Same as "" (no user group)
  • OSUserGroup Specify the default OS user group

cannot use this to increase permissions of the current user.

CategoryUser, groups and ESS
See Also ChangeRecordGroup, CurrentRecordGroup, FieldPermissions, FirstUserGroup, FirstUserName, NextUserGroup, NextUserName, RecordPermissions, ShowRecordGroup, UserAccountExpiry, UserGroup, UserName, UserPasswordExpiry, UserPermission
Example

This example attempts to move the current user from the "Sales" group to the "Support" group.

If SysUserGroup = "Sales" Then SetUserGroup "Support"