ARGetListServer

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 the list of available AR System server defined in the ar directory file (UNIX only). BMC Remedy Developer Studio and BMC Remedy Data Import connect to these servers automatically if no servers are specified at startup. If the ar file is under NIS control, the system uses the file specified by the NIS map instead of the local ar file. For information about the ar file, see ar-cfg-or-ar-conf.

Note

In the Windows API, server information is retrieved from the registry instead of the ar file. API programs that run on the server (for example, through a filter or escalation) can use this function to retrieve only the name of that local server. Programs that run on a Windows client, however, cannot. In this case, the function always returns a list of zero servers.

Privileges

All users.

Synopsis

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

int ARGetListServer(
  ARControlStruct *control,
  ARServerNameList *serverList,
  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

serverList

A list of zero or more registered AR System server. The system returns a list with zero items if no AR System server are registered.

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.