TIM SDK
TIM API C
error_messages.h File Reference

Description

Error messages.

Functions

ta_e_result_code_t ta_error_message_get_terminal (ta_object_t *message, ta_e_result_code_t result_code, ta_object_t terminal)
 Get translation for error text matching terminal language. More...
 
ta_e_result_code_t ta_error_message_get_language (ta_object_t *message, ta_e_result_code_t result_code, const char *language)
 Get translation for error text. More...
 

Function Documentation

◆ ta_error_message_get_language()

ta_e_result_code_t ta_error_message_get_language ( ta_object_t message,
ta_e_result_code_t  result_code,
const char *  language 
)

Get translation for error text.

Parameters
[out]messagePointer to variable to write object instance to. Object instance is of type string and is retained.
[in]result_codeResult code to get error message for.
[in]languageLanguage code to get error message for. If no entry for language is found the default error message is returned. Use null-pointer to get the default error message.
Return values
ta_c_rc_okObject instance written to message.
ta_c_rc_invalid_argumentmessage is null-pointer.
ta_c_rc_invalid_argumentresult_code is not a valid result code.
ta_c_rc_out_of_memoryFailed allocating memory.

◆ ta_error_message_get_terminal()

ta_e_result_code_t ta_error_message_get_terminal ( ta_object_t message,
ta_e_result_code_t  result_code,
ta_object_t  terminal 
)

Get translation for error text matching terminal language.

Parameters
[out]messagePointer to variable to write object instance to. Object instance is of type string and is retained.
[in]result_codeResult code to get error message for.
[in]terminalTerminal object to get language from. Object of type terminal. You have to call ta_terminal_system_information or ta_terminal_system_information_async first to obtain the terminal language. Otherwise the default language is used.
Return values
ta_c_rc_okObject instance written to message.
ta_c_rc_invalid_argumentmessage is null-pointer.
ta_c_rc_invalid_argumentterminal is ta_invalid_object.
ta_c_rc_invalid_argumentterminal is not of type terminal.
ta_c_rc_invalid_argumentresult_code is not a valid result code.
ta_c_rc_out_of_memoryFailed allocating memory.