TIM SDK
TIM API C
vas_result.h File Reference

Description

Contains VAS result.

Object type vas_result.

Functions

ta_e_result_code_t ta_vas_result_create (ta_object_t *vas_result, ta_e_vas_info_list_type_t vas_info_list_type, ta_object_t vas_information)
 Create vas result. More...
 
ta_e_result_code_t ta_vas_result_get_vas_information_list_type (ta_object_t vas_result, ta_e_vas_info_list_type_t *type)
 VAS information list type. More...
 
ta_e_result_code_t ta_vas_result_get_vas_information (ta_object_t vas_result, ta_object_t *vas_information)
 Map of VAS information. More...
 

Function Documentation

◆ ta_vas_result_create()

ta_e_result_code_t ta_vas_result_create ( ta_object_t vas_result,
ta_e_vas_info_list_type_t  vas_info_list_type,
ta_object_t  vas_information 
)

Create vas result.

Parameters
[out]vas_resultPointer to variable to write created object instance to. Created object instance is retained.
[in]vas_info_list_typeVas information list type.
[in]vas_informationObject instance is of type map and is retained. The map contains keys of type integer and values of type string (binary data).
Return values
ta_c_rc_okObject instance has been created and written to vas_result.
ta_c_rc_invalid_argumentvas_result is null-pointer.
ta_c_rc_invalid_argumentvas_information is ta_invalid_object.
ta_c_rc_invalid_argumentvas_information is not of type map.
ta_c_rc_out_of_memoryFailed allocating memory.

◆ ta_vas_result_get_vas_information()

ta_e_result_code_t ta_vas_result_get_vas_information ( ta_object_t  vas_result,
ta_object_t vas_information 
)

Map of VAS information.

Parameters
[in]vas_resultObject instance of type vas_result.
[out]vas_informationPointer to variable to write object instance to. Object instance is of type map and is not retained. The map contains keys of type integer and values of type string (binary data). If list is not present ta_invalid_object is written.
Return values
ta_c_rc_okObject instance written to vas_informations.
ta_c_rc_invalid_argumentvas_result is ta_invalid_object.
ta_c_rc_invalid_argumentvas_result is not of type vas_result.
ta_c_rc_invalid_argumentvas_information is null-pointer.

◆ ta_vas_result_get_vas_information_list_type()

ta_e_result_code_t ta_vas_result_get_vas_information_list_type ( ta_object_t  vas_result,
ta_e_vas_info_list_type_t type 
)

VAS information list type.

Parameters
[in]vas_resultObject instance of type vas_result.
[out]typePointer to variable to write type to.
Return values
ta_c_rc_okObject instance written to vas_informations.
ta_c_rc_invalid_argumentvas_result is ta_invalid_object.
ta_c_rc_invalid_argumentvas_result is not of type vas_result.
ta_c_rc_invalid_argumenttype is null-pointer.