mobile_topup_data.h File Reference

Description

Mobile topup issuer information result.

Object type mobile_topup_data.

Functions
ta_e_result_code_t	ta_mobile_topup_data_create (ta_object_t *data)
	Create object of type mobile_topup_data. More...
ta_e_result_code_t	ta_mobile_topup_data_get_brand_name (ta_object_t data, ta_object_t *brand_name)
	Contains the brand name of a card. The brand name information is retrieved from the card. More...
ta_e_result_code_t	ta_mobile_topup_data_get_mobile_topup_serial_number (ta_object_t data, ta_object_t *mobile_topup_serial_number)
	Contains the serial number of a (mobile topup) voucher. More...
ta_e_result_code_t	ta_mobile_topup_data_get_mobile_topup_refill_code (ta_object_t data, ta_object_t *mobile_topup_refill_code)
	Contains the refill code of a (mobile topup) voucher. More...
ta_e_result_code_t	ta_mobile_topup_data_get_card_expiry_date (ta_object_t data, ta_object_t *card_expiry_date)
	Card expiration date. This information is retrieved from the card. More...
ta_e_result_code_t	ta_mobile_topup_data_get_print_data (ta_object_t data, ta_object_t *print_data)
	Print data if present. More...

Function Documentation

ta_mobile_topup_data_create()

ta_e_result_code_t ta_mobile_topup_data_create

(

ta_object_t *

data

)

Create object of type mobile_topup_data.

Parameters

[out]

data

Pointer to variable to write created object instance to. Created object instance is retained.

Return values

ta_c_rc_ok	Object instance has been created and written to value.
ta_c_rc_invalid_argument	value is null-pointer.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_mobile_topup_data_get_brand_name()

ta_e_result_code_t ta_mobile_topup_data_get_brand_name	(	ta_object_t	data,
		ta_object_t *	brand_name
	)

Contains the brand name of a card. The brand name information is retrieved from the card.

Parameters

[in]	data	Object instance of type mobile_topup_data.
[out]	brand_name	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in mobile_topup_data.

Return values

ta_c_rc_ok	Object instance written to brand_name.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_data.
ta_c_rc_invalid_argument	brand_name is not null-pointer.

ta_mobile_topup_data_get_card_expiry_date()

ta_e_result_code_t ta_mobile_topup_data_get_card_expiry_date	(	ta_object_t	data,
		ta_object_t *	card_expiry_date
	)

Card expiration date. This information is retrieved from the card.

Parameters

[in]	data	Object instance of type mobile_topup_data.
[out]	card_expiry_date	Pointer to variable to write object instance to. Object instance is of type timedate and is not retained. Object instance is ta_object_invalid if value is not set in value.

Return values

ta_c_rc_ok	Object instance written to card_expiry_date.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_data.
ta_c_rc_invalid_argument	card_expiry_date is not null-pointer.

ta_mobile_topup_data_get_mobile_topup_refill_code()

ta_e_result_code_t ta_mobile_topup_data_get_mobile_topup_refill_code	(	ta_object_t	data,
		ta_object_t *	mobile_topup_refill_code
	)

Contains the refill code of a (mobile topup) voucher.

Parameters

[in]	data	Object instance of type mobile_topup_data.
[out]	mobile_topup_refill_code	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in mobile_topup_data.

Return values

ta_c_rc_ok	Object instance written to mobile_topup_refill_code.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_data.
ta_c_rc_invalid_argument	mobile_topup_refill_code is not null-pointer.

ta_mobile_topup_data_get_mobile_topup_serial_number()

ta_e_result_code_t ta_mobile_topup_data_get_mobile_topup_serial_number	(	ta_object_t	data,
		ta_object_t *	mobile_topup_serial_number
	)

Contains the serial number of a (mobile topup) voucher.

Parameters

[in]	data	Object instance of type mobile_topup_data.
[out]	mobile_topup_serial_number	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in mobile_topup_data.

Return values

ta_c_rc_ok	Object instance written to mobile_topup_serial_number.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_data.
ta_c_rc_invalid_argument	mobile_topup_serial_number is not null-pointer.

ta_mobile_topup_data_get_print_data()

ta_e_result_code_t ta_mobile_topup_data_get_print_data	(	ta_object_t	data,
		ta_object_t *	print_data
	)

Print data if present.

Parameters

[in]	data	Object instance of type mobile_topup_data.
[out]	print_data	Pointer to variable to write object instance to. Object instance is of type list with entries of type print_data and is not retained. Object instance is ta_object_invalid if value is not set in value.

Return values

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