dev_get_exception_data — Access the elements of an exception tuple.
dev_get_exception_data enables to access specific
items of an exception tuple that was caught by the operator
Except the error code that is always passed as the first element of the
exception tuple all other data of the exception tuple has to be accessed
exclusively via the operator
This is due to the fact that the order and the extent of the provided data
may change in future versions and may vary for the different code exports.
If an operator error occurred within HDevelop or HDevEngine, the caught
exception tuple contains the data items listed below.
This tuple has to be passed to the parameter
The name of the requested data slot has to be passed to the parameter
The requested data is returned in the parameter
By passing a tuple of slot names to
Name it is possible to
request several exception data items in a single call of
In that case a corresponding data tuple is returned in
For requested items that are not available an empty string
('') is returned.
Note that the operator
dev_get_exception_data is meant to be used
within HDevelop or HDevEngine. Some information is not available when the
operator is exported.
Supported data slots:
HALCON or user defined error code. A list of HALCON error codes (codes < 10000) can be found in the appendix of the “Extension Package Programmer's Manual”.
Additional HDevelop specific error code. These error codes specify whether an error was caught within the HALCON operator (code = 21000) or outside the operator, e.g., during the evaluation and assignment of the parameter expressions. In the latter case the error code specifies the error type more precisely. The relevant error codes are listed in the "HDevelop User's Guide".
HALCON error message.
Additional error message that describes the HDevelop specific error more precisely.
Number of the program line, where the error occurred.
Name of the operator that threw the exception (if the exception was thrown in a protected procedure, '--protected--' is returned instead of the operator name).
Depth of the call stack (if the error occurred in 'main' a depth of 1 is returned).
Name of the procedure where the error occurred.
User defined exception tuple.
If an operator exception was caught and rethrown, this is the tuple
that was appended to the caught exception tuple in the call of
In case of a completely user defined exception all tuple items except
the first element containing the error code (>= 30000)
If no user data was passed with the exception tuple, an empty tuple
Note, that the user data tuple cannot be requested together with any
other exception data in one
→(integer / string)
Tuple containing the exception data or user defined error codes.
Name(s) of the requested exception data.
Default value: 'error_code'
List of values: 'add_error_code', 'add_error_message', 'call_stack_depth', 'error_code', 'error_message', 'operator', 'procedure', 'program_line', 'user_data'
→(integer / string)
Requested exception data.
If the values of the specified parameters are correct,
dev_get_exception_data (as operator) returns 2 (H_MSG_TRUE). Otherwise an
exception is raised and an error code returned.