ARGetMultipleLocalizedValues

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 multiple localized text strings from the Message Catalog. The messages that the server retrieves depend on the user locale in the control structure. This function performs the same action as ARGetLocalizedValues but is easier to use and more efficient than retrieving multiple values one by one.

Synopsis

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

int ARGetMultipleLocalizedValues(
  ARControlStruct *control,
  ARLocalizedRequestList *localizedRequestList,
  ARValueList *localizedValueList,
  ARTimestampList *timestampList,
  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.

localizedRequestList

A list of identifications for the localized value to be retrieved. The list contains the type of value, value name, and unique identification numbers for some types of values.

Return values

localizedValueList

A list of the localized values to be retrieved. The values can be a character value or an attachment.

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

timestampList

A list of time stamps that specify the last change to the values.

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

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.