ARGetListUser

Important

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 users from the specified AR System server. You can retrieve information about the current user, all registered users, or all users currently accessing the server.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARGetListUser(
  ARControlStruct *control,
  unsigned int userListType,
  ARTimestamp changedSince,
  ARUserInfoList *userList,
  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.

userListType

A value that indicates the user type to be retrieved.

changedSince

A time stamp that limits the list entries retrieved to those modified after the specified time.

Specify 0 for this parameter to retrieve entries with any modification time stamp. The changedSince parameter applies only if the userListType parameter is set to: AR_USER_LIST_REGISTERED.

Return values

userList

List of zero or more users that match the criteria defined by the userListType parameter. The list contains the user name and license type. If you retrieve the current user, the list also contains a time stamp that specifies the last server access. The system returns a list with zero items if no users 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.