amount_discount.h File Reference

Description

Discount Amount.

Object type amount_discount.

Functions
ta_e_result_code_t	ta_amount_discount_get_value (ta_object_t amount, int64_t *value)
	Discount amount in minor units. More...
ta_e_result_code_t	ta_amount_discount_get_decimal_value (ta_object_t amount, double *value)
	Discount amount in major units as double precision floating point value. More...
ta_e_result_code_t	ta_amount_discount_get_currency (ta_object_t amount, ta_e_currency_t *currency)
	Discount currency. More...
ta_e_result_code_t	ta_amount_discount_get_exponent (ta_object_t amount, int *exponent)
	Discount exponent. More...
ta_e_result_code_t	ta_amount_discount_get_discount_id (ta_object_t amount, ta_object_t *identifier)
	Discount identifier. More...

Function Documentation

ta_amount_discount_get_currency()

ta_e_result_code_t ta_amount_discount_get_currency	(	ta_object_t	amount,
		ta_e_currency_t *	currency
	)

Discount currency.

Parameters

[in]	amount	Object instance of type amount_discount.
[out]	currency	Pointer to variable to write currency to.

Return values

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_discount.
ta_c_rc_invalid_argument	currency is null-pointer.

ta_amount_discount_get_decimal_value()

ta_e_result_code_t ta_amount_discount_get_decimal_value	(	ta_object_t	amount,
		double *	value
	)

Discount amount in major units as double precision floating point value.

Note

Double precision floating point values can not provide the same level of numerical accuracy as int64_t. It is recommended to use the integer based methods.

Parameters

[in]	amount	Object instance of type amount_discount.
[out]	value	Pointer to variable to write value to.

Return values

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_discount.
ta_c_rc_invalid_argument	value is null-pointer.

ta_amount_discount_get_discount_id()

ta_e_result_code_t ta_amount_discount_get_discount_id	(	ta_object_t	amount,
		ta_object_t *	identifier
	)

Discount identifier.

Parameters

[in]	amount	Object instance of type amount_discount.
[out]	identifier	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if identifier is not set in amount_discount.

Return values

ta_c_rc_ok	Object instance written to identifier.
ta_c_rc_invalid_argument	amount is ta_invalid_object.
ta_c_rc_invalid_argument	amount is not of type amount_discount.
ta_c_rc_invalid_argument	identifier is null-pointer.

ta_amount_discount_get_exponent()

ta_e_result_code_t ta_amount_discount_get_exponent	(	ta_object_t	amount,
		int *	exponent
	)

Discount exponent.

Parameters

[in]	amount	Object instance of type amount_discount.
[out]	exponent	Pointer to variable to write exponent to.

Return values

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_discount.
ta_c_rc_invalid_argument	exponent is null-pointer.

ta_amount_discount_get_value()

ta_e_result_code_t ta_amount_discount_get_value	(	ta_object_t	amount,
		int64_t *	value
	)

Discount amount in minor units.

Parameters

[in]	amount	Object instance of type amount_discount.
[out]	value	Pointer to variable to write value to. Use ta_amount_discount_get_exponent to get the used exponent. This can be a different exponent than the one defined by the used currency.

Return values

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_discount.
ta_c_rc_invalid_argument	value is null-pointer.