GET GROUP PROPERTIES
GET GROUP PROPERTIES ( groupID ; name ; owner {; members} )
| Parameter | Type | Description | |
|---|---|---|---|
| groupID | Integer | → | Unique group ID number |
| name | Text | ← | Name of the group |
| owner | Integer | ← | User ID number of group owner (Binary databases only) |
| members | Array integer | ← | Group members |
This command is not thread-safe, it cannot be used in preemptive code.
Description
GET GROUP PROPERTIES returns the properties of the group whose unique group ID number you pass in groupID. You must pass a valid group ID number returned by the command GET GROUP LIST.
If you do not pass a valid group ID number, GET GROUP PROPERTIES returns empty parameters.
After the call, you retrieve the name of the group in the name parameter.
(Binary databases only) The owner of the group is returned in the owner parameter. This parameter always returns 0 in project databases.
If you pass the optional members parameter, the unique ID numbers of the users and groups belonging to the group are returned.
Note for binary databases: Group and user ID values depend on their creator (Designer, Administrator, or affiliated group owner). For more information, please refer to the User and group ID ranges paragraph.
Error management
If you do not have the proper access privileges for calling GET GROUP PROPERTIES or if the Password system is already accessed by another process, an access privilege error is generated. You can catch this error with an error-handling method installed using ON ERR CALL.