counters.h File Reference

Description

Contains all counters for a specific counter type.

Object type counters.

Instances of this class are returned by various calls:

• ta_terminal_balance
• ta_terminal_balance_async
• ta_terminal_counter_request
• ta_terminal_counter_request_async
• ta_terminal_deactivate
• ta_terminal_deactivate_async
• ta_terminal_reconciliation
• ta_terminal_reconciliation_async

Functions
ta_e_result_code_t	ta_counters_get_counter_type (ta_object_t counters, ta_e_counter_type_t *counter_type)
	Specifies what kind of counter are demanded. More...
ta_e_result_code_t	ta_counters_get_seq_counter (ta_object_t counters, int *seq_counter)
	Activation or period sequence counter depending on type. More...
ta_e_result_code_t	ta_counters_get_counters (ta_object_t counters, ta_object_t *list_counters)
	Counters per brand. More...
ta_e_result_code_t	ta_counters_get_print_data (ta_object_t counters, ta_object_t *print_data)
	Optional print data. Present only in ta_c_rt_counter_request. More...

Function Documentation

ta_counters_get_counter_type()

ta_e_result_code_t ta_counters_get_counter_type	(	ta_object_t	counters,
		ta_e_counter_type_t *	counter_type
	)

Specifies what kind of counter are demanded.

Parameters

[in]	counters	Object instance of type counters.
[out]	counter_type	Pointer to variable to write value to.

Return values

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

ta_counters_get_counters()

ta_e_result_code_t ta_counters_get_counters	(	ta_object_t	counters,
		ta_object_t *	list_counters
	)

Counters per brand.

Parameters

[in]	counters	Object instance of type counters.
[out]	list_counters	Pointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type counter.

Return values

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

ta_counters_get_print_data()

ta_e_result_code_t ta_counters_get_print_data	(	ta_object_t	counters,
		ta_object_t *	print_data
	)

Optional print data. Present only in ta_c_rt_counter_request.

Parameters

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

Return values

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

ta_counters_get_seq_counter()

ta_e_result_code_t ta_counters_get_seq_counter	(	ta_object_t	counters,
		int *	seq_counter
	)

Activation or period sequence counter depending on type.

Parameters

[in]	counters	Object instance of type counters.
[out]	seq_counter	Pointer to variable to write value to.

Return values

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