ARVerifyUser

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

Checks the cache on the specified server to determine whether the specified user is registered with the current server.

Privileges

All users.

Synopsis

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

int ARVerifyUser(
  ARControlStruct *control,
  ARBoolean *adminFlag,
  ARBoolean *subAdminFlag,
  ARBoolean *customFlag,
  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.

Return values

adminFlag

A flag that indicates whether the specified user is a member of the Administrator group. The system returns 1 (TRUE) if the user is a member of the Administrator group. The system returns 0 (FALSE) if the user is not a member of the Administrator group, is invalid, or is unknown. Specify NULL for this parameter if you do not want to retrieve this flag.

subAdminFlag

A flag that indicates whether the specified user is a member of the Subadministrator group. The system always returns 1 (TRUE) if the user is a member of the Subadministrator group. The system returns 0 (FALSE) if the user is not a member of the Subadministrator group, is invalid, or is unknown. Specify NULL for this parameter if you do not want to retrieve this flag.

customFlag

A flag that indicates whether the specified user is a member of the Customize group. The system always returns 1 (TRUE) if the user is a member of the Customize group. The system returns 0 (FALSE) if the user is not a member of the Customize group, is invalid, or is unknown. Specify NULL for this parameter if you do not want to retrieve this flag.

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.