TIM SDK
TIM API C
|
|
DCC Amount.
Object type amount_dcc.
ta_e_result_code_t ta_amount_dcc_get_currency | ( | ta_object_t | amount, |
ta_e_currency_t * | currency | ||
) |
DCC Currency.
[in] | amount | Object instance of type amount_dcc. |
[out] | currency | Pointer to variable to write currency to. |
ta_c_rc_ok | Value written to currency. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | currency is null-pointer. |
ta_e_result_code_t ta_amount_dcc_get_decimal_value | ( | ta_object_t | amount, |
double * | value | ||
) |
DCC Amount in major units as double precision floating point value.
[in] | amount | Object instance of type amount_dcc. |
[out] | value | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to value. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | value is null-pointer. |
ta_e_result_code_t ta_amount_dcc_get_exponent | ( | ta_object_t | amount, |
int * | exponent | ||
) |
DCC Exponent.
[in] | amount | Object instance of type amount_dcc. |
[out] | exponent | Pointer to variable to write exponent to. |
ta_c_rc_ok | Value written to exponent. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | exponent is null-pointer. |
ta_e_result_code_t ta_amount_dcc_get_markup | ( | ta_object_t | amount, |
int * | markup | ||
) |
DCC Markup in minor units.
[in] | amount | Object instance of type amount_dcc. |
[out] | markup | Pointer to variable to write markup to. |
ta_c_rc_ok | Value written to markup. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | markup is null-pointer. |
ta_e_result_code_t ta_amount_dcc_get_markup_decimal | ( | ta_object_t | amount, |
double * | markup | ||
) |
DCC Markup in major units as double precision floating point value.
DCC markup exponent has been applied already to the value. Returned value can be used as-is without the need to adjust for the exponent.
[in] | amount | Object instance of type amount_dcc. |
[out] | markup | Pointer to variable to write markup to. |
ta_c_rc_ok | Value written to markup. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | markup is null-pointer. |
ta_e_result_code_t ta_amount_dcc_get_markup_exponent | ( | ta_object_t | amount, |
int * | exponent | ||
) |
DCC Markup exponent.
[in] | amount | Object instance of type amount_dcc. |
[out] | exponent | Pointer to variable to write markup exponent to. |
ta_c_rc_ok | Value written to exponent. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | exponent is null-pointer. |
ta_e_result_code_t ta_amount_dcc_get_rate | ( | ta_object_t | amount, |
int * | rate | ||
) |
DCC Rate in minor units.
[in] | amount | Object instance of type amount_dcc. |
[out] | rate | Pointer to variable to write rate to. |
ta_c_rc_ok | Value written to rate. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | rate is null-pointer. |
ta_e_result_code_t ta_amount_dcc_get_rate_decimal | ( | ta_object_t | amount, |
double * | rate | ||
) |
DCC Rate in major units as double precision floating point value.
DCC rate exponent has been applied already to the value. Returned value can be used as-is without the need to adjust for the exponent.
[in] | amount | Object instance of type amount_dcc. |
[out] | rate | Pointer to variable to write rate to. |
ta_c_rc_ok | Value written to rate. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | rate is null-pointer. |
ta_e_result_code_t ta_amount_dcc_get_rate_exponent | ( | ta_object_t | amount, |
int * | exponent | ||
) |
DCC rate exponent.
[in] | amount | Object instance of type amount_dcc. |
[out] | exponent | Pointer to variable to write rate exponent to. |
ta_c_rc_ok | Value written to exponent. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | exponent is null-pointer. |
ta_e_result_code_t ta_amount_dcc_get_value | ( | ta_object_t | amount, |
int64_t * | value | ||
) |
DCC Amount in minor units.
[in] | amount | Object instance of type amount_dcc. |
[out] | value | Pointer to variable to write value to. Use ta_amount_dcc_get_exponent to get the used exponent. This can be a different exponent than the one defined by the used currency. |
ta_c_rc_ok | Value written to value. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount_dcc. |
ta_c_rc_invalid_argument | value is null-pointer. |