total.h File Reference

Description

Contains information about the total for one currency.

Object type total.

Functions
ta_e_result_code_t	ta_total_get_count (ta_object_t total, int *count)
	Number of transactions. More...
ta_e_result_code_t	ta_total_get_amount_sum (ta_object_t total, ta_object_t *amount_sum)
	Total amount per currency. More...
ta_e_result_code_t	ta_total_get_amount_sum_tip (ta_object_t total, ta_object_t *amount_sum)
	Total tip amount per currency. More...
ta_e_result_code_t	ta_total_get_amount_sum_other (ta_object_t total, ta_object_t *amount_sum)
	Total other amount per currency. More...
ta_e_result_code_t	ta_total_get_trx_details (ta_object_t total, ta_object_t *trx_details)
	List of transaction details. More...
ta_e_result_code_t	ta_total_get_currency (ta_object_t total, ta_e_currency_t *currency)
	Currency. More...
ta_e_result_code_t	ta_total_get_exponent (ta_object_t total, int *exponent)
	Exponent. More...

Function Documentation

ta_total_get_amount_sum()

ta_e_result_code_t ta_total_get_amount_sum	(	ta_object_t	total,
		ta_object_t *	amount_sum
	)

Total amount per currency.

Parameters

[in]	total	Object instance of type total.
[out]	amount_sum	Pointer to variable to write object instance to. Object instance is of type amount and is not retained.

Return values

ta_c_rc_ok	Object instance written to amount_sum.
ta_c_rc_invalid_argument	total is ta_invalid_object.
ta_c_rc_invalid_argument	total is not of type total.
ta_c_rc_invalid_argument	amount_sum is null-pointer.

ta_total_get_amount_sum_other()

ta_e_result_code_t ta_total_get_amount_sum_other	(	ta_object_t	total,
		ta_object_t *	amount_sum
	)

Total other amount per currency.

Parameters

[in]	total	Object instance of type total.
[out]	amount_sum	Pointer to variable to write object instance to. Object instance is of type amount and is not retained.

Return values

ta_c_rc_ok	Object instance written to amount_sum.
ta_c_rc_invalid_argument	total is ta_invalid_object.
ta_c_rc_invalid_argument	total is not of type total.
ta_c_rc_invalid_argument	amount_sum is null-pointer.

ta_total_get_amount_sum_tip()

ta_e_result_code_t ta_total_get_amount_sum_tip	(	ta_object_t	total,
		ta_object_t *	amount_sum
	)

Total tip amount per currency.

Parameters

[in]	total	Object instance of type total.
[out]	amount_sum	Pointer to variable to write object instance to. Object instance is of type amount and is not retained.

Return values

ta_c_rc_ok	Object instance written to amount_sum.
ta_c_rc_invalid_argument	total is ta_invalid_object.
ta_c_rc_invalid_argument	total is not of type total.
ta_c_rc_invalid_argument	amount_sum is null-pointer.

ta_total_get_count()

ta_e_result_code_t ta_total_get_count	(	ta_object_t	total,
		int *	count
	)

Number of transactions.

Parameters

[in]	total	Object instance of type total.
[out]	count	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to count.
ta_c_rc_invalid_argument	total is ta_invalid_object.
ta_c_rc_invalid_argument	total is not of type total.
ta_c_rc_invalid_argument	count is null-pointer.

ta_total_get_currency()

ta_e_result_code_t ta_total_get_currency	(	ta_object_t	total,
		ta_e_currency_t *	currency
	)

Currency.

Parameters

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

Return values

ta_c_rc_ok	Object instance written to currency.
ta_c_rc_invalid_argument	total is ta_invalid_object.
ta_c_rc_invalid_argument	total is not of type total.
ta_c_rc_invalid_argument	currency is null-pointer.

ta_total_get_exponent()

ta_e_result_code_t ta_total_get_exponent	(	ta_object_t	total,
		int *	exponent
	)

Exponent.

Parameters

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

Return values

ta_c_rc_ok	Object instance written to currency.
ta_c_rc_invalid_argument	total is ta_invalid_object.
ta_c_rc_invalid_argument	total is not of type total.
ta_c_rc_invalid_argument	exponent is null-pointer.

ta_total_get_trx_details()

ta_e_result_code_t ta_total_get_trx_details	(	ta_object_t	total,
		ta_object_t *	trx_details
	)

List of transaction details.

Parameters

[in]	total	Object instance of type total.
[out]	trx_details	Pointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type trx_detail.

Return values

ta_c_rc_ok	Object instance written to trx_details.
ta_c_rc_invalid_argument	total is ta_invalid_object.
ta_c_rc_invalid_argument	total is not of type total.
ta_c_rc_invalid_argument	trx_details is null-pointer.