ARGetLocalizedValue

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 a localized text string from the BMC Remedy Message Catalog. The message that the server retrieves depends on the user locale.

Privileges

All users.

Synopsis

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

int ARGetLocalizedValue(
  ARControlStruct *control,
  ARLocalizedRequestStruct *localizedRequest,
  ARValueStruct *localizedValue,
  ARTimestamp *timestamp,
  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.

localizedRequest

Identification for the localized value to be retrieved from the BMC Remedy Message Catalog. It contains the type of value, value name, and, for some types of values, unique identification numbers.

Return values

localizedValue

The localized value to be retrieved. The value can be a character value or an attachment. Specify NULL for this argument if you do not want to retrieve this value.

timestamp

A time stamp that specifies the last change to the value. Specify NULL for this parameter 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.