ARGetListGroup
Privileges
Group information for the current user can be retrieved by all users. Access to group information for other users is limited to users with AR System administrator privileges.
Users without administrator privileges can only see groups they are assigned to in the User form Group List menu.
Synopsis
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"
int ARGetListGroup(
ARControlStruct *control,
ARAccessNameType userName,
ARAccessNameType password,
ARGroupInfoList *groupList,
ARStatusList *status)
Input arguments
control
The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.
userName
The name of the user for which the system retrieves group information. Specify NULL for this parameter to retrieve all groups on the server.
password
The password of the user for whom the system retrieves the list.
If you specify NULL, the function returns the group list for the first user whose name matches the name passed, not necessarily the user who requested the list.
If you specify a password, the server returns the group list for the user whose name and password match those in the parameter list.
Return values
groupList
A list of zero or more groups that match the criteria defined by the userName parameter. Each item in the list contains a group ID, the name associated with that ID, group category, and the computed group qualification string. The system returns a list with zero items if no groups match the specified criteria.
status
A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.