gmSCErrorCodeClass

Owned by Mark Juras
Last updated: Jul 25, 2018Version comment

The ErrorCode Service Class

The service class ErrorCode is used to record errors that occur doing processing operations. These errors can occur within any class; therefore, to avoid circular references, this class is completely self-contained. There is a setter ErrorCode_SetCode and a getter ErrorCode_GetCode available for use via the engine-based facilities of the system. It can also be set and accessed -- i.e., tested -- directly via the global field ErrorCode_Value.

The field ErrorCode_Value

Prototype


extern int ErrorCode_Value;
The ErrorCode_Value field contains the current value of the processing error code.

The method ErrorCode_GetCode

Prototype


int ErrorCode_GetCode(void);
The ErrorCode_GetCode method returns the current value of the processing error code.

The method ErrorCode_SetCode

Prototype


void ErrorCode_SetCode(int errorCode);
The ErrorCode_SetCode method sets the processing error code to the specified value. Its parameter is:

Parameter Description
errorCode Specifies the new value of the processing error code.


Table of Contents