TIM SDK
TIM API C
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...
 

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]countersObject instance of type counters.
[out]counter_typePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to counter_type.
ta_c_rc_invalid_argumentcounters is ta_invalid_object.
ta_c_rc_invalid_argumentcounters is not of type counters.
ta_c_rc_invalid_argumentcounter_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]countersObject instance of type counters.
[out]list_countersPointer 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_okObject instance written to list_counters.
ta_c_rc_invalid_argumentcounters is ta_invalid_object.
ta_c_rc_invalid_argumentcounters is not of type counters.
ta_c_rc_invalid_argumentlist_counters 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]countersObject instance of type counters.
[out]seq_counterPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to seq_counter.
ta_c_rc_invalid_argumentcounters is ta_invalid_object.
ta_c_rc_invalid_argumentcounters is not of type counters.
ta_c_rc_invalid_argumentseq_counter is null-pointer.