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]	hardware	Object instance of type hardware.
[out]	firmware_version	Pointer 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 hardware.

Return values

ta_c_rc_ok	Object instance written to firmware_version.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	firmware_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]	hardware	Object instance of type hardware.
[out]	hardware_address	Pointer 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 hardware.

Return values

ta_c_rc_ok	Object instance written to last_cleaning_date.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	hardware_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]	hardware	Object instance of type hardware.
[out]	hardware_description	Pointer 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 hardware.

Return values

ta_c_rc_ok	Object instance written to last_cleaning_date.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	hardware_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]	hardware	Object instance of type hardware.
[out]	hardware_type	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to hardware_type.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	hardware_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]	hardware	Object instance of type hardware.
[out]	iccid	Pointer 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 hardware.

Return values

ta_c_rc_ok	Object instance written to last_cleaning_date.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	iccid 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]	hardware	Object instance of type hardware.
[out]	imei	Pointer 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 hardware.

Return values

ta_c_rc_ok	Object instance written to last_cleaning_date.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	imei 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]	hardware	Object instance of type hardware.
[out]	imsi	Pointer 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 hardware.

Return values

ta_c_rc_ok	Object instance written to last_cleaning_date.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	imsi 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]	hardware	Object instance of type hardware.
[out]	last_cleaning_date	Pointer to variable to write object instance to. Object instance is of type timedate and is not retained. Object instance is ta_invalid_object if value is not set in hardware.

Return values

ta_c_rc_ok	Object instance written to last_cleaning_date.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	last_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]	hardware	Object instance of type hardware.
[out]	product_version	Pointer 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 hardware.

Return values

ta_c_rc_ok	Object instance written to product_version.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	product_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]	hardware	Object instance of type hardware.
[out]	production_date	Pointer to variable to write object instance to. Object instance is of type timedate and is not retained. Object instance is ta_invalid_object if value is not set in hardware.

Return values

ta_c_rc_ok	Object instance written to production_date.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	production_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]	hardware	Object instance of type hardware.
[out]	security_status	Pointer to variable to write value to. value is ta_c_ss_undefined if value is not set in hardware.

Return values

ta_c_rc_ok	Object instance written to security_status.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	security_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]	hardware	Object instance of type hardware.
[out]	serial_number	Pointer 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 hardware.

Return values

ta_c_rc_ok	Object instance written to serial_number.
ta_c_rc_invalid_argument	hardware is ta_invalid_object.
ta_c_rc_invalid_argument	hardware is not of type hardware.
ta_c_rc_invalid_argument	serial_number is null-pointer.