Sq3Lite_Error_RB_API

Sq3Lite PACKAGE - work with an error … More...

Collaboration diagram for Sq3Lite_Error_RB_API:

Functions
static OT_ProcRet	rbsq3lite_Sq3Lite_ErrorCheckI (OtClass_ARGS)
	Ruby: (static) bool Sq3Lite.ErrorCheckI(ret:Sq3ErrorE) → C-API check if ret signal an error …

Detailed Description

Sq3Lite PACKAGE - work with an error …

Error handling in rbsq3lite.

The error signals the end of an operation with an undesirable result or state.

• The error is defined using the both enum: enum Sq3ErrorE and enum Sq3ExtendetResultCodesE
• In a programming language WITHOUT explicit error handling (eg "C") this value is returned and the subsequent code must process the error, eg with Sq3ErrorE_Check.
• In a programming language WITH explicit error handling (eg "Java"), the error is converted into an exception and the program flow is aborted with an error message.

Function Documentation

rbsq3lite_Sq3Lite_ErrorCheckI()

static OT_ProcRet rbsq3lite_Sq3Lite_ErrorCheckI ( OtClass_ARGS )

static

Ruby: (static) bool Sq3Lite.ErrorCheckI(ret:Sq3ErrorE) → C-API
check if ret signal an error …

Definition at line 1758 of file LibSq3Lite_rb.c.

                                                         {
  OT_SETUP_hdl_static;
  OT_SETUP_ONEARG(ErrorCheckI_doc);
  enum Sq3ErrorE ret = 0;
  OT_CHECK_REQUIRED(OT_CHECK_ENUM (Sq3ErrorE,ret))
  OT_CHECK_NOARGS;
  OT_retObj_SET_BOL(Sq3ErrorCheckI (ret));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}