Equinox Online Help - Language Reference - A to Z

Home

UserChangeGroup

Applies to
SyntaxUserChangeGroup LoginExpression, GroupNameExpression
Action[Funtion] Changes the user specified in the login string to belong to the group specified in the groupname string, or no group if it is supplied as ""
ScopeUsable anywhere
NotesThis command changes the user specified in the login string to belong to the group specified in the groupname string, or no group if it is supplied as "". The command returns SysError as zero if the command succeeds, or nonzero if an error occurs. The command can fail for one of the following reasons:
  • The executing user does not have user management permission.
  • Any of the permissions in the target group is not held by the executing user's group.
  • The target user is the equinox user.
  • The target user is not found.
  • The target group is not "" (no group) and not found.
  • Someone else is currently updating that user, and the lock attempt timed out.
  • If the group is the same as the current group, it succeeds silently and the permissions are not checked.
  • If the target user is the executing user, the logged in rights are immediately updated. This implies that you cannot go back to your previous group.
CategoryUser, groups and ESS
See Also ChangePassword, FirstUserGroup, FirstUserName, UserCreate, NextUserGroup, NextUserName, SetUserGroup, UserAccountExpiry, UserDelete, UserDetails, UserGroup, UserName, UserPasswordExpiry, UserResetPassword
Example