This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

ARGetListGroup

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Retrieves a list of access control groups from the specified server. You can retrieve all groups or limit the list to groups associated with a particular user.

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 BMC Remedy AR System administrator privileges.

Synopsis

#include "ar.h"
#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 this parameter is NULL, the function returns the group list for the first user whose name matches the name passed in, not necessarily the user who requested the list. If this parameter specifies 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.

See also

ARGetListUser. See FreeAR for: FreeARGroupInfoList, FreeARStatusList.

Was this page helpful? Yes No Submitting... Thank you

Comments