merchant_option.h File Reference

Description

Merchant option.

Object type merchant_option.

Functions
ta_e_result_code_t	ta_merchant_option_create (ta_object_t *merchant_option, ta_e_merchant_option_type_t type, ta_object_t value)
	Create object of type merchant_option. More...
ta_e_result_code_t	ta_merchant_option_get_type (ta_object_t merchant_option, ta_e_merchant_option_type_t *type)
	Type of merchant option. More...
ta_e_result_code_t	ta_merchant_option_get_value (ta_object_t merchant_option, ta_object_t *value)
	Option value. More...

Function Documentation

ta_merchant_option_create()

ta_e_result_code_t ta_merchant_option_create	(	ta_object_t *	merchant_option,
		ta_e_merchant_option_type_t	type,
		ta_object_t	value
	)

Create object of type merchant_option.

Parameters

[out]	merchant_option	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	type	Merchant option type.
[in]	value	Option value of type string.

Return values

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

ta_merchant_option_get_type()

ta_e_result_code_t ta_merchant_option_get_type	(	ta_object_t	merchant_option,
		ta_e_merchant_option_type_t *	type
	)

Type of merchant option.

Parameters

[in]	merchant_option	Object instance of type merchant_option.
[out]	type	Pointer to variable to write value to. Value is ta_c_mot_undefined if value is not set in merchant_option.

Return values

ta_c_rc_ok	Object instance written to type.
ta_c_rc_invalid_argument	merchant_option is ta_object_invalid.
ta_c_rc_invalid_argument	merchant_option is not of type merchant_option.
ta_c_rc_invalid_argument	type is null-pointer.

ta_merchant_option_get_value()

ta_e_result_code_t ta_merchant_option_get_value	(	ta_object_t	merchant_option,
		ta_object_t *	value
	)

Option value.

Parameters

[in]	merchant_option	Object instance of type merchant_option.
[out]	value	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 merchant_option.

Return values

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