Operator Reference

HALCON Operator Reference / System / Error Handling

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

get_extended_error_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info (Operator)

get_extended_error_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info — Returns the extended error information for the calling thread's last HALCON error.

Signature

get_extended_error_info( : : : OperatorName, ErrorCode, ErrorMessage)

Herror get_extended_error_info(char* OperatorName, Hlong* ErrorCode, char* ErrorMessage)

Herror T_get_extended_error_info(Htuple* OperatorName, Htuple* ErrorCode, Htuple* ErrorMessage)

void GetExtendedErrorInfo(HTuple* OperatorName, HTuple* ErrorCode, HTuple* ErrorMessage)

static HString HSystem::GetExtendedErrorInfo(Hlong* ErrorCode, HString* ErrorMessage)

static void HOperatorSet.GetExtendedErrorInfo(out HTuple operatorName, out HTuple errorCode, out HTuple errorMessage)

static string HSystem.GetExtendedErrorInfo(out int errorCode, out string errorMessage)

def get_extended_error_info() -> Tuple[str, int, str]

Description

get_extended_error_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info returns the last error code that occurred in the calling thread. OperatorNameOperatorNameOperatorNameoperatorNameoperator_name contains the operator name of the HALCON operator that has set this error code. ErrorCodeErrorCodeErrorCodeerrorCodeerror_code holds the actual error code and ErrorMessageErrorMessageErrorMessageerrorMessageerror_message the corresponding error message. If no error code has been set so far or a HALCON error comes with no extended error information, OperatorNameOperatorNameOperatorNameoperatorNameoperator_name and ErrorMessageErrorMessageErrorMessageerrorMessageerror_message contain an empty string and ErrorCodeErrorCodeErrorCodeerrorCodeerror_code is set to 0. Please refer to 'Result' slot of the particular operator reference to determine whether and on which occasion an operator provides extended error information.

get_extended_error_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info is thread-local, i.e., the extended error information is maintained on a per thread basis. Setting an extended error code in one thread does not affect the extended error information in any other thread. This also implies that an error code can only be retrieved within the thread that was calling the operator setting the extended error. A thread-local extended error will be cleared (and set again when applicable) as soon as an error occurs in any other successive operator call within the same thread, if get_systemget_systemGetSystemGetSystemget_system is called from within the same thread with the 'tsp_clear_extended_error'"tsp_clear_extended_error""tsp_clear_extended_error""tsp_clear_extended_error""tsp_clear_extended_error" parameter, or the thread terminates.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

OperatorNameOperatorNameOperatorNameoperatorNameoperator_name (output_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Operator that set the error code.

ErrorCodeErrorCodeErrorCodeerrorCodeerror_code (output_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Extended error code.

ErrorMessageErrorMessageErrorMessageerrorMessageerror_message (output_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Extended error message.

See also

get_error_textget_error_textGetErrorTextGetErrorTextget_error_text

Module

none

---

ClassesClasses | | Operators