Operator Reference

HALCON Operator Reference / System / Error Handling

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

ClassesClasses | | Operators

get_error_textget_error_textGetErrorTextGetErrorTextget_error_text (Operator)

get_error_textget_error_textGetErrorTextGetErrorTextget_error_text — Inquiry after the error text of a HALCON error number.

Signature

get_error_text( : : ErrorCode : ErrorMessage)

Herror get_error_text(const Hlong ErrorCode, char* ErrorMessage)

Herror T_get_error_text(const Htuple ErrorCode, Htuple* ErrorMessage)

void GetErrorText(const HTuple& ErrorCode, HTuple* ErrorMessage)

static HString HSystem::GetErrorText(Hlong ErrorCode)

static void HOperatorSet.GetErrorText(HTuple errorCode, out HTuple errorMessage)

static string HSystem.GetErrorText(int errorCode)

def get_error_text(error_code: int) -> str

Description

The operator get_error_textget_error_textGetErrorTextGetErrorTextget_error_text returns the error message for the corresponding HALCON error code. This is indeed the same text which will be given during an exception. The operator get_error_textget_error_textGetErrorTextGetErrorTextget_error_text is especially useful if the error treatment is programmed by the users themselves (see also set_check(::'~give_error':)set_check("~give_error")SetCheck("~give_error")SetCheck("~give_error")set_check("~give_error")).

Attention

Unknown error codes will trigger a standard message.

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

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

HALCON error code.

Restriction: 1 <= ErrorCode && ErrorCode <= 36000

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

Corresponding error message.

Example (C)

Herror   err;
char       message[MAX_STRING];

set_check("~give_error");
err = send_region(region,socket);
set_check("give_error");
if (err != H_MSG_TRUE) {
get_error_text((Hlong)err,message);
  fprintf(stderr,"my error message: %s\n",message);
  exit(1);
}

Result

The operator get_error_textget_error_textGetErrorTextGetErrorTextget_error_text returns the value 2 ( H_MSG_TRUE) , if the parameters are correct. Otherwise an exception will be raised.

Possible Predecessors

set_checkset_checkSetCheckSetCheckset_check

See also

set_checkset_checkSetCheckSetCheckset_check

Module

none

---

ClassesClasses | | Operators