ucErrorMessage

See Also: ucError, ucSetError, Error Handling

Returns an error message.

ucErrorMessage([ErrorNumber [, tHandle]])

Parameters

ErrorNumber

Optional. When ErrorNumber is specified, the text of the corresponding error message is returned. If this argument is omitted, or has a value of 0, then the error message associated with the most recent transaction is returned. ErrorNumber can be either a value that you have configured, or one of the pre-defined constants:

uc_Err_Syntax_Error

uc_Err_Undefined_Identifier

uc_Err_Unknown_Error

uc_Err_Unrecognized_Pattern

uc_Err_Unrecognized_Command

uc_Err_Datatype_Mismatch

uc_Err_Invalid_Argument_Count

uc_Err_Invalid_Definition

uc_Err_CodeBlock_Error

uc_Err_Undefined_Callback

uc_Err_Array_Bounds_Exceeded

uc_Err_Float_Denormal_Operand

uc_Err_Float_Divide_By_Zero

uc_Err_Float_Inexact_Result

uc_Err_Float_Invalid_Operation

uc_Err_Float_Overflow

uc_Err_Float_Stack_Check

uc_Err_Float_Underflow

uc_Err_Integer_Divide_By_Zero

uc_Err_Integer_Overflow

uc_Err_Privileged_Instruction

tHandle

Optional. Each thread has its own definitions, and keeps separate track of its errors. By specifying this argument, you can select which thread to check for an error. If no thread is specified, the default thread is implied.

New or Enhanced

• There are additional messages, including things like Overflow, Underflow, and more.
• The syntax for ucErrorMessage is more uniform across various compilers.

Issues for users migrating from version 2.0

• Error messages were reorganized. Some messages were removed, and others added. The numbering is different.
• In version 2.0, the name of the offending item (such as a function or variable name) was returned with ucErrorData(0). Now you should use an error handling callback routine instead to achieve that functionality.