balance_response.h File Reference

Description

Balance Response.

Object type balance_response.

Functions
ta_e_result_code_t	ta_balance_response_get_print_data (ta_object_t response, ta_object_t *print_data)
	Print information for merchant receipt. More...
ta_e_result_code_t	ta_balance_response_get_counters (ta_object_t response, ta_object_t *counters)
	Balance counters. More...
ta_e_result_code_t	ta_balance_response_get_partial_exceptions (ta_object_t response, ta_object_t *partial_exceptions)
	Partial exceptions due to one or more Omni-Channel clients failing. More...

Function Documentation

ta_balance_response_get_counters()

ta_e_result_code_t ta_balance_response_get_counters	(	ta_object_t	response,
		ta_object_t *	counters
	)

Balance counters.

Parameters

[in]	response	Object instance of type balance_response.
[out]	counters	Pointer to variable to write object instance to. Object instance is of type counters and is not retained.

Return values

ta_c_rc_ok	Object instance written to counters.
ta_c_rc_invalid_argument	response is ta_object_invalid.
ta_c_rc_invalid_argument	response is not of type balance_response.
ta_c_rc_invalid_argument	counters is null-pointer.

ta_balance_response_get_partial_exceptions()

ta_e_result_code_t ta_balance_response_get_partial_exceptions	(	ta_object_t	response,
		ta_object_t *	partial_exceptions
	)

Partial exceptions due to one or more Omni-Channel clients failing.

Parameters

[in]	response	Object instance of type balance_response.
[out]	partial_exceptions	Pointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type integer. The integer value matches ta_e_result_code_t. Object instance is ta_object_invalid if value is not set in response.

Return values

ta_c_rc_ok	Object instance written to partial_exceptions.
ta_c_rc_invalid_argument	response is ta_object_invalid.
ta_c_rc_invalid_argument	response is not of type balance_response.
ta_c_rc_invalid_argument	partial_exceptions is null-pointer.

ta_balance_response_get_print_data()

ta_e_result_code_t ta_balance_response_get_print_data	(	ta_object_t	response,
		ta_object_t *	print_data
	)

Print information for merchant receipt.

Parameters

[in]	response	Object instance of type balance_response.
[out]	print_data	Pointer to variable to write object instance to. Object instance is of type print_data and is not retained. Object instance is ta_object_invalid if value is not set in response.

Return values

ta_c_rc_ok	Object instance written to print_data.
ta_c_rc_invalid_argument	response is ta_object_invalid.
ta_c_rc_invalid_argument	response is not of type balance_response.
ta_c_rc_invalid_argument	print_data is null-pointer.