ARGetMultipleCurrencyRatioSets

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 list of formatted currency ratio sets valid for the times specified in the ratioTimestamps argument. You can use ARGetCurrencyRatio to extract a specific currency ratio from a ratio set that ARGetMultipleCurrencyRatioSets returns.

Privileges

All users.

Synopsis

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

int ARGetMultipleCurrencyRatioSets(
  ARControlStruct *control,
  ARTimestampList *ratioTimestamps,
  ARTextStringList *currencyRatioSets,
  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.

ratioTimestamps

A list of time stamps that represent times to retrieve sets of ratios. Specify the AR_CURRENT_CURRENCY_RATIOS constant as a time stamp to retrieve a set of current ratios for each conversion combination. If no ratio exists for a currency code combination exactly at the specified point in time, the closest earlier ratio is returned.

Return values

currencyRatioSets

A pointer to a structure that contains a list of formatted character strings, each of which represents the set of currency ratios for the corresponding point in time, as the ratioTimestamps argument specifies. If there are no available currency ratios that qualify, such as when there are no earlier ratios, the corresponding character string is an empty string.

You must free the memory allocated within the structure described previously. To determine the value for a specific ratio from the formatted character string, use the function ARGetCurrencyRatio.

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.