TIM SDK
TIM API C
receipt_item.h File Reference

Description

Receipt item.

Object type receipt_item.

Functions

ta_e_result_code_t ta_receipt_item_get_receipt_item_type (ta_object_t receipt_item, ta_e_receipt_item_type_t *receipt_item_type)
 Type of receipt item. More...
 
ta_e_result_code_t ta_receipt_item_get_recipient (ta_object_t receipt_item, ta_e_recipient_t *recipient)
 Recipient. More...
 
ta_e_result_code_t ta_receipt_item_get_value (ta_object_t receipt_item, ta_object_t *value)
 Value of the receipt item. More...
 

Function Documentation

◆ ta_receipt_item_get_receipt_item_type()

ta_e_result_code_t ta_receipt_item_get_receipt_item_type ( ta_object_t  receipt_item,
ta_e_receipt_item_type_t receipt_item_type 
)

Type of receipt item.

Parameters
[in]receipt_itemObject instance of type receipt_item.
[out]receipt_item_typePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to receipt_item_type.
ta_c_rc_invalid_argumentreceipt_item is ta_object_invalid.
ta_c_rc_invalid_argumentreceipt_item is not of type receipt_item.
ta_c_rc_invalid_argumentreceipt_item_type is null-pointer.

◆ ta_receipt_item_get_recipient()

ta_e_result_code_t ta_receipt_item_get_recipient ( ta_object_t  receipt_item,
ta_e_recipient_t recipient 
)

Recipient.

Parameters
[in]receipt_itemObject instance of type receipt_item.
[out]recipientPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to recipient.
ta_c_rc_invalid_argumentreceipt_item is ta_object_invalid.
ta_c_rc_invalid_argumentreceipt_item is not of type receipt_item.
ta_c_rc_invalid_argumentrecipient is null-pointer.

◆ ta_receipt_item_get_value()

ta_e_result_code_t ta_receipt_item_get_value ( ta_object_t  receipt_item,
ta_object_t value 
)

Value of the receipt item.

Parameters
[in]receipt_itemObject instance of type receipt_item.
[out]valuePointer to variable to write object instance to. Object instance is of type string and is not retained.
Return values
ta_c_rc_okObject instance written to value.
ta_c_rc_invalid_argumentreceipt_item is ta_object_invalid.
ta_c_rc_invalid_argumentreceipt_item is not of type receipt_item.
ta_c_rc_invalid_argumentvalue is null-pointer.