TIM SDK
TIM API C
ecr_info.h File Reference

Description

Ecr info.

Object type ecr_info.

Functions

ta_e_result_code_t ta_ecr_info_create (ta_object_t *ecr_info)
 Create object of type ecr_info. More...
 
ta_e_result_code_t ta_ecr_info_get_type (ta_object_t ecr_info, ta_e_ecr_info_type_t *type)
 Information type. More...
 
ta_e_result_code_t ta_ecr_info_set_type (ta_object_t ecr_info, ta_e_ecr_info_type_t type)
 Set information type. More...
 
ta_e_result_code_t ta_ecr_info_get_name (ta_object_t ecr_info, ta_object_t *name)
 Information name. More...
 
ta_e_result_code_t ta_ecr_info_set_name (ta_object_t ecr_info, ta_object_t name)
 Set information name. More...
 
ta_e_result_code_t ta_ecr_info_get_manufacturer_name (ta_object_t ecr_info, ta_object_t *manufacturer_name)
 Information manufacturer name. More...
 
ta_e_result_code_t ta_ecr_info_set_manufacturer_name (ta_object_t ecr_info, ta_object_t manufacturer_name)
 Set information manufacturer name. More...
 
ta_e_result_code_t ta_ecr_info_get_version (ta_object_t ecr_info, ta_object_t *version)
 Information version. More...
 
ta_e_result_code_t ta_ecr_info_set_version (ta_object_t ecr_info, ta_object_t version)
 Set information version. More...
 
ta_e_result_code_t ta_ecr_info_get_serial_number (ta_object_t ecr_info, ta_object_t *serial_number)
 Information serial number. More...
 
ta_e_result_code_t ta_ecr_info_set_serial_number (ta_object_t ecr_info, ta_object_t serial_number)
 Set information serial number. More...
 
ta_e_result_code_t ta_ecr_info_get_architecture (ta_object_t ecr_info, ta_object_t *architecture)
 Information architecture. More...
 
ta_e_result_code_t ta_ecr_info_set_architecture (ta_object_t ecr_info, ta_object_t architecture)
 Set information architecture. More...
 
ta_e_result_code_t ta_ecr_info_get_integrator_solution (ta_object_t ecr_info, ta_object_t *integrator_solution)
 Integrator solution. More...
 
ta_e_result_code_t ta_ecr_info_set_integrator_solution (ta_object_t ecr_info, ta_object_t integrator_solution)
 Set integrator solution. More...
 
ta_e_result_code_t ta_ecr_info_get_remote_ip (ta_object_t ecr_info, ta_object_t *remote_ip)
 Remote IP. More...
 
ta_e_result_code_t ta_ecr_info_set_remote_ip (ta_object_t ecr_info, ta_object_t remote_ip)
 Set remote IP. More...
 

Function Documentation

◆ ta_ecr_info_create()

ta_e_result_code_t ta_ecr_info_create ( ta_object_t ecr_info)

Create object of type ecr_info.

Parameters
[out]ecr_infoPointer to variable to write created object instance to. Created object instance is retained.
Return values
ta_c_rc_okObject instance has been created and written to ecr_info.
ta_c_rc_invalid_argumentecr_info is null-pointer.
ta_c_rc_out_of_memoryFailed allocating memory.

◆ ta_ecr_info_get_architecture()

ta_e_result_code_t ta_ecr_info_get_architecture ( ta_object_t  ecr_info,
ta_object_t architecture 
)

Information architecture.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[out]architecturePointer 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 ecr_info.
Return values
ta_c_rc_okObject instance written to architecture.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentarchitecture is null-pointer.

◆ ta_ecr_info_get_integrator_solution()

ta_e_result_code_t ta_ecr_info_get_integrator_solution ( ta_object_t  ecr_info,
ta_object_t integrator_solution 
)

Integrator solution.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[out]integrator_solutionPointer 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 ecr_info.
Return values
ta_c_rc_okObject instance written to integrator_solution.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentintegrator_solution is null-pointer.

◆ ta_ecr_info_get_manufacturer_name()

ta_e_result_code_t ta_ecr_info_get_manufacturer_name ( ta_object_t  ecr_info,
ta_object_t manufacturer_name 
)

Information manufacturer name.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[out]manufacturer_namePointer 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 ecr_info.
Return values
ta_c_rc_okObject instance written to manufacturer_name.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentmanufacturer_name is null-pointer.

◆ ta_ecr_info_get_name()

ta_e_result_code_t ta_ecr_info_get_name ( ta_object_t  ecr_info,
ta_object_t name 
)

Information name.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[out]namePointer 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 ecr_info.
Return values
ta_c_rc_okObject instance written to name.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentname is null-pointer.

◆ ta_ecr_info_get_remote_ip()

ta_e_result_code_t ta_ecr_info_get_remote_ip ( ta_object_t  ecr_info,
ta_object_t remote_ip 
)

Remote IP.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[out]remote_ipPointer 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 ecr_info.
Return values
ta_c_rc_okObject instance written to remote_ip.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentremote_ip is null-pointer.

◆ ta_ecr_info_get_serial_number()

ta_e_result_code_t ta_ecr_info_get_serial_number ( ta_object_t  ecr_info,
ta_object_t serial_number 
)

Information serial number.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[out]serial_numberPointer 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 ecr_info.
Return values
ta_c_rc_okObject instance written to serial_number.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentserial_number is null-pointer.

◆ ta_ecr_info_get_type()

ta_e_result_code_t ta_ecr_info_get_type ( ta_object_t  ecr_info,
ta_e_ecr_info_type_t type 
)

Information type.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[out]typePointer to variable to write value to. Value is ta_c_eit_undefined if value is not set in ecr_info.
Return values
ta_c_rc_okObject instance written to type.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumenttype is null-pointer.

◆ ta_ecr_info_get_version()

ta_e_result_code_t ta_ecr_info_get_version ( ta_object_t  ecr_info,
ta_object_t version 
)

Information version.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[out]versionPointer 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 ecr_info.
Return values
ta_c_rc_okObject instance written to version.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentversion is null-pointer.

◆ ta_ecr_info_set_architecture()

ta_e_result_code_t ta_ecr_info_set_architecture ( ta_object_t  ecr_info,
ta_object_t  architecture 
)

Set information architecture.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[in]architectureObject instance to set. Object instance can be ta_invalid_object to clear the value in ecr_info. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to ecr_info.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentarchitecture is not ta_invalid_object and is not of type string.

◆ ta_ecr_info_set_integrator_solution()

ta_e_result_code_t ta_ecr_info_set_integrator_solution ( ta_object_t  ecr_info,
ta_object_t  integrator_solution 
)

Set integrator solution.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[in]integrator_solutionObject instance to set. Object instance can be ta_invalid_object to clear the value in ecr_info. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to ecr_info.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentintegrator_solution is not ta_invalid_object and is not of type string.

◆ ta_ecr_info_set_manufacturer_name()

ta_e_result_code_t ta_ecr_info_set_manufacturer_name ( ta_object_t  ecr_info,
ta_object_t  manufacturer_name 
)

Set information manufacturer name.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[in]manufacturer_nameObject instance to set. Object instance can be ta_invalid_object to clear the value in ecr_info. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to ecr_info.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentmanufacturer_name is not ta_invalid_object and is not of type string.

◆ ta_ecr_info_set_name()

ta_e_result_code_t ta_ecr_info_set_name ( ta_object_t  ecr_info,
ta_object_t  name 
)

Set information name.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[in]nameObject instance to set. Object instance can be ta_invalid_object to clear the value in ecr_info. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to ecr_info.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentname is not ta_invalid_object and is not of type string.

◆ ta_ecr_info_set_remote_ip()

ta_e_result_code_t ta_ecr_info_set_remote_ip ( ta_object_t  ecr_info,
ta_object_t  remote_ip 
)

Set remote IP.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[in]remote_ipObject instance to set. Object instance can be ta_invalid_object to clear the value in ecr_info. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to ecr_info.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentremote_ip is not ta_invalid_object and is not of type string.

◆ ta_ecr_info_set_serial_number()

ta_e_result_code_t ta_ecr_info_set_serial_number ( ta_object_t  ecr_info,
ta_object_t  serial_number 
)

Set information serial number.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[in]serial_numberObject instance to set. Object instance can be ta_invalid_object to clear the value in ecr_info. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to ecr_info.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentserial_number is not ta_invalid_object and is not of type string.

◆ ta_ecr_info_set_type()

ta_e_result_code_t ta_ecr_info_set_type ( ta_object_t  ecr_info,
ta_e_ecr_info_type_t  type 
)

Set information type.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[in]typeValue to set. Value can be ta_c_eit_undefined to clear the value in ecr_info.
Return values
ta_c_rc_okValue assigned to ecr_info.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.

◆ ta_ecr_info_set_version()

ta_e_result_code_t ta_ecr_info_set_version ( ta_object_t  ecr_info,
ta_object_t  version 
)

Set information version.

Parameters
[in]ecr_infoObject instance of type ecr_info.
[in]versionObject instance to set. Object instance can be ta_invalid_object to clear the value in ecr_info. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to ecr_info.
ta_c_rc_invalid_argumentecr_info is ta_invalid_object.
ta_c_rc_invalid_argumentecr_info is not of type ecr_info.
ta_c_rc_invalid_argumentversion is not ta_invalid_object and is not of type string.