ucErrorMessage

See Also: ucError, Error Handling, ucRaiseError

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 error constants.

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.� If you are calling ucErrorMessage from a centralized error handling callback, then tHandle should generally not be omitted.

New or enhanced in version 3.0

� Nothing related to this topic.

� See What�s New.

Note: The wording for some error messages has changed.

New or enhanced in version 2.96

• uc_Err_Dynamically_Defined is new.� It is used by ucRaiseErrorMessage.

New or enhanced in version 2.9+

• 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 along with ucErrSymbol() to achieve that functionality.