TIM SDK
TIM API C
command_response.h File Reference

Description

Command response.

Object type command_response.

Functions

ta_e_result_code_t ta_command_response_get_order (ta_object_t response, int *order)
 Specifies the order of a CommandResponse in the CommandResponseList. More...
 
ta_e_result_code_t ta_command_response_get_response_type (ta_object_t response, ta_e_response_type_t *response_type)
 Defines the outcome type of the command response. More...
 
ta_e_result_code_t ta_command_response_get_card_response (ta_object_t response, ta_object_t *card_response)
 Response received from card. More...
 
ta_e_result_code_t ta_command_response_get_uid (ta_object_t response, ta_object_t *uid)
 UID of the card. More...
 
ta_e_result_code_t ta_command_response_get_atr (ta_object_t response, ta_object_t *atr)
 Answer to reset information received from the card. More...
 

Function Documentation

◆ ta_command_response_get_atr()

ta_e_result_code_t ta_command_response_get_atr ( ta_object_t  response,
ta_object_t atr 
)

Answer to reset information received from the card.

Parameters
[in]responseObject instance of type command_response.
[out]atrPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to atr.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type command_response.
ta_c_rc_invalid_argumentatr is null-pointer.

◆ ta_command_response_get_card_response()

ta_e_result_code_t ta_command_response_get_card_response ( ta_object_t  response,
ta_object_t card_response 
)

Response received from card.

Parameters
[in]responseObject instance of type command_response.
[out]card_responsePointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to card_response.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type command_response.
ta_c_rc_invalid_argumentcard_response is null-pointer.

◆ ta_command_response_get_order()

ta_e_result_code_t ta_command_response_get_order ( ta_object_t  response,
int *  order 
)

Specifies the order of a CommandResponse in the CommandResponseList.

Parameters
[in]responseObject instance of type command_response.
[out]orderPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to order.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type command_response.
ta_c_rc_invalid_argumentorder is null-pointer.

◆ ta_command_response_get_response_type()

ta_e_result_code_t ta_command_response_get_response_type ( ta_object_t  response,
ta_e_response_type_t response_type 
)

Defines the outcome type of the command response.

Parameters
[in]responseObject instance of type command_response.
[out]response_typePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to response_type.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type command_response.
ta_c_rc_invalid_argumentresponse_type is null-pointer.

◆ ta_command_response_get_uid()

ta_e_result_code_t ta_command_response_get_uid ( ta_object_t  response,
ta_object_t uid 
)

UID of the card.

Parameters
[in]responseObject instance of type command_response.
[out]uidPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to uid.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type command_response.
ta_c_rc_invalid_argumentuid is null-pointer.