TIM SDK
TIM API C
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_optionPointer to variable to write created object instance to. Created object instance is retained.
[in]typeMerchant option type.
[in]valueOption value of type string.
Return values
ta_c_rc_okObject instance has been created and written to merchant_option.
ta_c_rc_invalid_argumentmerchant_option is null-pointer.
ta_c_rc_invalid_argumenttype has invalid value.
ta_c_rc_invalid_argumentvalue is ta_invalid_object.
ta_c_rc_out_of_memoryFailed 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_optionObject instance of type merchant_option.
[out]typePointer 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_okObject instance written to type.
ta_c_rc_invalid_argumentmerchant_option is ta_invalid_object.
ta_c_rc_invalid_argumentmerchant_option is not of type merchant_option.
ta_c_rc_invalid_argumenttype 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_optionObject instance of type merchant_option.
[out]valuePointer 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 merchant_option.
Return values
ta_c_rc_okObject instance written to value.
ta_c_rc_invalid_argumentmerchant_option is ta_invalid_object.
ta_c_rc_invalid_argumentmerchant_option is not of type merchant_option.
ta_c_rc_invalid_argumentvalue is null-pointer.