UserGrps Class Members
- Last UpdatedNov 06, 2025
- 5 minute read
The following tables list the members exposed by UserGrps.
| Name | Description | |
|---|---|---|
  | AddUserGroup | Overloaded. The AddUserGroup() method takes a user group description and creates a new user group, returning the group ID. |
| AddUserToGroups | The AddUserToGroups() method adds a user to a group. |
| CloneUserGroup | The CloneUserGroup() method creates a new user group based on a specified existing user group, assigning the passed description to the new user group. This method also copies all of the user group link records from the source user group to the new user group. Therefore, all users in the source group are part of the new group. This method also copies the source group's entity access and privileges to the new group. The group ID of the new group is returned. |
| DeleteUserFromGroup | The DeleteUserFromGroup() method removes the specified user from the specified group. |
| DeleteUserFromGroups | The DeleteUserFromGroups() method removes all users from the specified list of groups. |
| DeleteUserGroup | The DeleteUserGroup () method deletes the specified user group. All links to users are removed. Also all of the group links to entities and group links to privileges are removed for this user group. |
| DeleteUserGrpLinks | The DeleteUserFromGroup() method removes the specified user from the specified group. |
| GetGroupId | The GetGroupId() method retrieves the user group ID for a group, specified by a group description. |
| GetUserGroupEntities | The GetUserGroupEntities() method retrieves a DataSet containing all group entity link records of the specified entity. |
| GetUserGroupEntity | The GetUserGroupEntity() method retrieves a DataSet that contains all user group-entity link records for the specified user group. |
| GetUserGroupLinks | Overloaded. The GetUserGroupLinks() method retrieves a DataSet containing all user group link records. |
| GetUserGroupPrivileges | The GetUserGroupPrivileges() method retrieves a DataSet containing the group privileges link records of the specified group. |
| GetUserGroups | Overloaded. The GetUserGroups() method retrieves all user groups. |
| GiveUserGroupEntityAccess | The GiveUserGroupEntityAccess() method provides the specified user group with access to the specified entity. |
| SetUserGroupEntityAccess | The SetUserGroupEntityAccess() method sets or denies access to the specified entity for the specified user group, depending on the state of the access flag. |
| SetUserGroupPrivileges | The SetUserGroupPrivileges() method updates the value of the privileges in the list for the user group that is specified. The privileges list is a list of ordered pairs in the format "#:#". The first value is the privilege ID and the second value is the value. Each grp_priv_link record for the privileges in the list and for the specified user are updated with the values in the list. |
| SetUserGroupPrivValue | The SetUserGroupPrivValue() method sets the value of the specified privilege for the specified user group. |
| UpdateUserGroup | The UpdateUserGroup() method updates the data of the specified user group. |
| UpdateUserGroupDesc | The UpdateUserGroupDesc() method updates the description of the specified user group. |