hardware_information_response.h File Reference

Description

Contains the result of calling ta_terminal_hardware_information or ta_terminal_hardware_information_async.

Object type hardware_information_response.

Functions
ta_e_result_code_t	ta_hardware_information_response_get_hardwares (ta_object_t response, ta_object_t *hardwares)
	List of hardware attached to the EFT Terminal.. More...
ta_e_result_code_t	ta_hardware_information_response_get_kernel_versions (ta_object_t response, ta_object_t *kernel_versions)
	Kernel versions supported by the EFT Terminal. More...
ta_e_result_code_t	ta_hardware_information_response_get_settings (ta_object_t response, ta_object_t *settings)
	Settings supported by the EFT Terminal. More...
ta_e_result_code_t	ta_hardware_information_response_get_statistics (ta_object_t response, ta_object_t *statistics)
	Hardware statistics. More...
ta_e_result_code_t	ta_hardware_information_response_get_battery_level (ta_object_t response, int *level)
	Charging level of the battery as a percentage value of the total charge. More...
ta_e_result_code_t	ta_hardware_information_response_get_battery_charging (ta_object_t response, ta_e_boolean_t *charging)
	Indicates whether the batterie is being charged i.e. the device is plugged in. More...

Function Documentation

ta_hardware_information_response_get_battery_charging()

ta_e_result_code_t ta_hardware_information_response_get_battery_charging	(	ta_object_t	response,
		ta_e_boolean_t *	charging
	)

Indicates whether the batterie is being charged i.e. the device is plugged in.

true: Plugged in false: Not plugged in

Parameters

[in]	response	Object instance of type hardware_information_response.
[out]	charging	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to statistics.
ta_c_rc_invalid_argument	response is ta_object_invalid.
ta_c_rc_invalid_argument	response is not of type hardware_information_response.
ta_c_rc_invalid_argument	statistics is null-pointer.

ta_hardware_information_response_get_battery_level()

ta_e_result_code_t ta_hardware_information_response_get_battery_level	(	ta_object_t	response,
		int *	level
	)

Charging level of the battery as a percentage value of the total charge.

0% is defined as the amount of charge where the device performs an automatic shutdown. 100% is a full charge.

Parameters

[in]	response	Object instance of type hardware_information_response.
[out]	level	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to statistics.
ta_c_rc_invalid_argument	response is ta_object_invalid.
ta_c_rc_invalid_argument	response is not of type hardware_information_response.
ta_c_rc_invalid_argument	statistics is null-pointer.

ta_hardware_information_response_get_hardwares()

ta_e_result_code_t ta_hardware_information_response_get_hardwares	(	ta_object_t	response,
		ta_object_t *	hardwares
	)

List of hardware attached to the EFT Terminal..

Parameters

[in]	response	Object instance of type hardware_information_response.
[out]	hardwares	Pointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type hardware.

Return values

ta_c_rc_ok	Object instance written to hardwares.
ta_c_rc_invalid_argument	response is ta_object_invalid.
ta_c_rc_invalid_argument	response is not of type hardware_information_response.
ta_c_rc_invalid_argument	hardwares is null-pointer.

ta_hardware_information_response_get_kernel_versions()

ta_e_result_code_t ta_hardware_information_response_get_kernel_versions	(	ta_object_t	response,
		ta_object_t *	kernel_versions
	)

Kernel versions supported by the EFT Terminal.

Parameters

[in]	response	Object instance of type hardware_information_response.
[out]	kernel_versions	Pointer 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. The keys match values from ta_e_kernel_type_t. The values are the string version of the kernel.

Return values

ta_c_rc_ok	Object instance written to kernel_versions.
ta_c_rc_invalid_argument	response is ta_object_invalid.
ta_c_rc_invalid_argument	response is not of type hardware_information_response.
ta_c_rc_invalid_argument	kernel_versions is null-pointer.

ta_hardware_information_response_get_settings()

ta_e_result_code_t ta_hardware_information_response_get_settings	(	ta_object_t	response,
		ta_object_t *	settings
	)

Settings supported by the EFT Terminal.

Parameters

[in]	response	Object instance of type hardware_information_response.
[out]	settings	Pointer 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. The keys match values from ta_e_setting_type_t.

Return values

ta_c_rc_ok	Object instance written to settings.
ta_c_rc_invalid_argument	response is ta_object_invalid.
ta_c_rc_invalid_argument	response is not of type hardware_information_response.
ta_c_rc_invalid_argument	settings is null-pointer.

ta_hardware_information_response_get_statistics()

ta_e_result_code_t ta_hardware_information_response_get_statistics	(	ta_object_t	response,
		ta_object_t *	statistics
	)

Hardware statistics.

Parameters

[in]	response	Object instance of type hardware_information_response.
[out]	statistics	Pointer to variable to write object instance to. Object instance is of type map and is not retained. The map contains keys and values both of type string.

Return values

ta_c_rc_ok	Object instance written to statistics.
ta_c_rc_invalid_argument	response is ta_object_invalid.
ta_c_rc_invalid_argument	response is not of type hardware_information_response.
ta_c_rc_invalid_argument	statistics is null-pointer.