ARGetCurrencyRatio

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 selected currency ratio from a set of ratios returned when a program makes a call to ARGetMultipleCurrencyRatioSets.

Privileges

All users.

Synopsis

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

int ARGetCurrencyRatio(
  ARControlStruct *control,
  char *currencyRatios,
  ARCurrencyCodeType fromCurrencyCode
  ARCurrencyCodeType toCurrencyCode
  ARValueStruct *currencyRatio,
  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 sessionId fields are required.

currencyRatios

A formatted currency ratio character string returned by a call to the ARGetMultipleCurrencyRatioSets function.

fromCurrencyCode

The source currency code for the conversion ratio.

toCurrencyCode

The target currency code for the conversion ratio.

Return values

currencyRatio

The conversion ratio for the specified source and target currency codes. The function returns a value structure of type AR_DATA_TYPE_NULL if there is no conversion ratio for the specified currency code combination. The function returns a value structure of type AR_DATA_TYPE_DECIMAL if there is a conversion ratio. You must free the AR_DATA_TYPE_DECIMAL value when it is no longer needed.

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.