TIM SDK
TIM API C
hardware.h File Reference

Description

Contains information about a piece of hardware in the terminal or devices attached to it.

Object type hardware.

Functions

ta_e_result_code_t ta_hardware_get_hardware_type (ta_object_t hardware, ta_e_hardware_type_t *hardware_type)
 Specifies the hardware. More...
 
ta_e_result_code_t ta_hardware_get_serial_number (ta_object_t hardware, ta_object_t *serial_number)
 Serial number of the specified hardware. More...
 
ta_e_result_code_t ta_hardware_get_production_date (ta_object_t hardware, ta_object_t *production_date)
 Production date of the specified hardware. More...
 
ta_e_result_code_t ta_hardware_get_product_version (ta_object_t hardware, ta_object_t *product_version)
 Product version of the specified hardware. More...
 
ta_e_result_code_t ta_hardware_get_firmware_version (ta_object_t hardware, ta_object_t *firmware_version)
 Firmware version of the specified hardware. More...
 
ta_e_result_code_t ta_hardware_get_security_status (ta_object_t hardware, ta_e_security_status_t *security_status)
 Security status of the specified hardware. More...
 
ta_e_result_code_t ta_hardware_get_last_cleaning_date (ta_object_t hardware, ta_object_t *last_cleaning_date)
 Available if HardwareType is ContactReader or MagStripeReader. More...
 
ta_e_result_code_t ta_hardware_get_imsi (ta_object_t hardware, ta_object_t *imsi)
 Imsi. More...
 
ta_e_result_code_t ta_hardware_get_imei (ta_object_t hardware, ta_object_t *imei)
 Imei. More...
 
ta_e_result_code_t ta_hardware_get_iccid (ta_object_t hardware, ta_object_t *iccid)
 Iccid. More...
 
ta_e_result_code_t ta_hardware_get_hardware_address (ta_object_t hardware, ta_object_t *hardware_address)
 Hardware address. More...
 
ta_e_result_code_t ta_hardware_get_hardware_description (ta_object_t hardware, ta_object_t *hardware_description)
 Hardware description. More...
 

Function Documentation

◆ ta_hardware_get_firmware_version()

ta_e_result_code_t ta_hardware_get_firmware_version ( ta_object_t  hardware,
ta_object_t firmware_version 
)

Firmware version of the specified hardware.

Parameters
[in]hardwareObject instance of type hardware.
[out]firmware_versionPointer 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 hardware.
Return values
ta_c_rc_okObject instance written to firmware_version.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumentfirmware_version is null-pointer.

◆ ta_hardware_get_hardware_address()

ta_e_result_code_t ta_hardware_get_hardware_address ( ta_object_t  hardware,
ta_object_t hardware_address 
)

Hardware address.

Parameters
[in]hardwareObject instance of type hardware.
[out]hardware_addressPointer 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 hardware.
Return values
ta_c_rc_okObject instance written to last_cleaning_date.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumenthardware_address is null-pointer.

◆ ta_hardware_get_hardware_description()

ta_e_result_code_t ta_hardware_get_hardware_description ( ta_object_t  hardware,
ta_object_t hardware_description 
)

Hardware description.

Parameters
[in]hardwareObject instance of type hardware.
[out]hardware_descriptionPointer 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 hardware.
Return values
ta_c_rc_okObject instance written to last_cleaning_date.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumenthardware_description is null-pointer.

◆ ta_hardware_get_hardware_type()

ta_e_result_code_t ta_hardware_get_hardware_type ( ta_object_t  hardware,
ta_e_hardware_type_t hardware_type 
)

Specifies the hardware.

Parameters
[in]hardwareObject instance of type hardware.
[out]hardware_typePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to hardware_type.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumenthardware_type is null-pointer.

◆ ta_hardware_get_iccid()

ta_e_result_code_t ta_hardware_get_iccid ( ta_object_t  hardware,
ta_object_t iccid 
)

Iccid.

Parameters
[in]hardwareObject instance of type hardware.
[out]iccidPointer 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 hardware.
Return values
ta_c_rc_okObject instance written to last_cleaning_date.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumenticcid is null-pointer.

◆ ta_hardware_get_imei()

ta_e_result_code_t ta_hardware_get_imei ( ta_object_t  hardware,
ta_object_t imei 
)

Imei.

Parameters
[in]hardwareObject instance of type hardware.
[out]imeiPointer 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 hardware.
Return values
ta_c_rc_okObject instance written to last_cleaning_date.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumentimei is null-pointer.

◆ ta_hardware_get_imsi()

ta_e_result_code_t ta_hardware_get_imsi ( ta_object_t  hardware,
ta_object_t imsi 
)

Imsi.

Parameters
[in]hardwareObject instance of type hardware.
[out]imsiPointer 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 hardware.
Return values
ta_c_rc_okObject instance written to last_cleaning_date.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumentimsi is null-pointer.

◆ ta_hardware_get_last_cleaning_date()

ta_e_result_code_t ta_hardware_get_last_cleaning_date ( ta_object_t  hardware,
ta_object_t last_cleaning_date 
)

Available if HardwareType is ContactReader or MagStripeReader.

Parameters
[in]hardwareObject instance of type hardware.
[out]last_cleaning_datePointer 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 hardware.
Return values
ta_c_rc_okObject instance written to last_cleaning_date.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumentlast_cleaning_date is null-pointer.

◆ ta_hardware_get_product_version()

ta_e_result_code_t ta_hardware_get_product_version ( ta_object_t  hardware,
ta_object_t product_version 
)

Product version of the specified hardware.

Parameters
[in]hardwareObject instance of type hardware.
[out]product_versionPointer 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 hardware.
Return values
ta_c_rc_okObject instance written to product_version.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumentproduct_version is null-pointer.

◆ ta_hardware_get_production_date()

ta_e_result_code_t ta_hardware_get_production_date ( ta_object_t  hardware,
ta_object_t production_date 
)

Production date of the specified hardware.

Parameters
[in]hardwareObject instance of type hardware.
[out]production_datePointer 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 hardware.
Return values
ta_c_rc_okObject instance written to production_date.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumentproduction_date is null-pointer.

◆ ta_hardware_get_security_status()

ta_e_result_code_t ta_hardware_get_security_status ( ta_object_t  hardware,
ta_e_security_status_t security_status 
)

Security status of the specified hardware.

Parameters
[in]hardwareObject instance of type hardware.
[out]security_statusPointer to variable to write value to. value is ta_c_ss_undefined if value is not set in hardware.
Return values
ta_c_rc_okObject instance written to security_status.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumentsecurity_status is null-pointer.

◆ ta_hardware_get_serial_number()

ta_e_result_code_t ta_hardware_get_serial_number ( ta_object_t  hardware,
ta_object_t serial_number 
)

Serial number of the specified hardware.

Parameters
[in]hardwareObject instance of type hardware.
[out]serial_numberPointer 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 hardware.
Return values
ta_c_rc_okObject instance written to serial_number.
ta_c_rc_invalid_argumenthardware is ta_object_invalid.
ta_c_rc_invalid_argumenthardware is not of type hardware.
ta_c_rc_invalid_argumentserial_number is null-pointer.