receipt.h File Reference

Description

Receipt.

Object type receipt.

Functions
ta_e_result_code_t	ta_receipt_create (ta_object_t *receipt, ta_e_recipient_t recipient, ta_object_t value)
	Create receipt. More...
ta_e_result_code_t	ta_receipt_get_recipient (ta_object_t receipt, ta_e_recipient_t *recipient)
	Recipient of the receipt. More...
ta_e_result_code_t	ta_receipt_get_value (ta_object_t receipt, ta_object_t *value)
	Receipt to print. More...

Function Documentation

ta_receipt_create()

ta_e_result_code_t ta_receipt_create	(	ta_object_t *	receipt,
		ta_e_recipient_t	recipient,
		ta_object_t	value
	)

Create receipt.

Parameters

[out]	receipt	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	recipient	Recipient.
[in]	value	Receipt text. Object instance has to be of type string.

Return values

ta_c_rc_ok	Object instance has been created and written to receipt.
ta_c_rc_invalid_argument	receipt is null-pointer.
ta_c_rc_invalid_argument	recipient is invalid value.
ta_c_rc_invalid_argument	value is ta_invalid_object.
ta_c_rc_invalid_argument	value is not of type string.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_receipt_get_recipient()

ta_e_result_code_t ta_receipt_get_recipient	(	ta_object_t	receipt,
		ta_e_recipient_t *	recipient
	)

Recipient of the receipt.

Parameters

[in]	receipt	Object instance of type receipt.
[out]	recipient	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to recipient.
ta_c_rc_invalid_argument	receipt is ta_invalid_object.
ta_c_rc_invalid_argument	receipt is not of type receipt.
ta_c_rc_invalid_argument	recipient is null-pointer.

ta_receipt_get_value()

ta_e_result_code_t ta_receipt_get_value	(	ta_object_t	receipt,
		ta_object_t *	value
	)

Receipt to print.

Parameters

[in]	receipt	Object instance of type receipt.
[out]	value	Pointer to variable to write object instance to. Object instance is of type string and is not retained.

Return values

ta_c_rc_ok	Object instance written to value.
ta_c_rc_invalid_argument	receipt is ta_invalid_object.
ta_c_rc_invalid_argument	receipt is not of type receipt.
ta_c_rc_invalid_argument	value is null-pointer.