ARGetVUI

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 information about the form view (VUI) with the indicated ID from the specified server.

Synopsis

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

int ARGetVUI(
  ARControlStruct *control,
  ARNameType schema,
  ARInternalId vuiId,
  ARNameType vuiName,
  ARLocaleType locale,
  unsigned int *vuiType,
  ARPropList *dPropList,
  char **helpText,
  ARTimestamp *timestamp,
  ARAccessNameType owner,
  ARAccessNameType lastChanged,
  char **changeDiary,
  ARPropList *objPropList,
  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.

To specify whether to search for an object's real or resolved name, use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARSetSessionConfiguration). For calls that use field or view IDs, the search is performed on the real or resolved name of the associated form.

If you do not use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable, the AR System server uses the default overlay group at run time. For information about configuring the default overlay group, see the description for Overlay-mode in ar-cfg-or-ar-conf-options-N-R.

schema

The name of the form containing the VUI to be retrieved.

vuiId

The internal ID of the VUI to be retrieved.

Return values

vuiName

The name of the VUI.

Specify NULL for this parameter if you do not want to retrieve the VUI name.

locale

The locale of the VUI.

Specify NULL for this parameter if you do not want to retrieve the locale.

vuiType

The type of VUI.

Specify NULL for this parameter if you do not want to retrieve the VUI type.

Field marked with an asterisk (*) is available for legacy environments that use the User form, which is no longer shipped with AR System.

dPropList

A list of zero or more display properties associated with the VUI. See ARCreateVUI for a description of the possible values. The system returns 0 (AR_DPROP_NONE) if the VUI has no display properties.

Specify NULL for this parameter if you do not want to retrieve this list.

helpText

The help text associated with the VUI.

Specify NULL for this parameter if you do not want to retrieve the help text. This value can be large, so do not retrieve it if the program does not need it; for example, if the program is only checking if an object exists.

timestamp

A time stamp that specifies the last change to the VUI.

Specify NULL for this parameter if you do not want to retrieve this value.

owner

The owning user for the VUI.

Specify NULL for this parameter if you do not want to retrieve the owner.

lastChanged

The user who made the last change to the VUI.

Specify NULL for this parameter if you do not want to retrieve this value.

changeDiary

The change diary associated with the VUI.

Use ARDecodeDiary to parse the change diary into user, time stamp, and text components. The server adds the user making the change and a time stamp when it saves the change diary.

Specify NULL for this parameter if you do not want to retrieve the change diary. This value can be large, so do not retrieve it if the program does not need it; for example, if the program is only checking if an object exists.

objPropList

A list of server object properties. If you set this parameter to NULL, no properties list is returned. See Server-object-properties-and-structures.

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.