Defines the action taken when errors are returned from AG Access functions.

DWORD adiSetErrorHandler(
CTAERROR_HANDLER handler )

handler Pointer to an error-handling routine provided by the application.

SUCCESS

None.

This function allows the application program to trap programming errors. If an error is encountered when executing a command, then AG Access performs the error action before returning to the application.

The error action is undertaken only when AG Access functions are invoked; it is not undertaken if an error is returned via an ADI_EVENT (see ADI_EVENT value field in adiFetchAndProcess).

By default, there is no error action. The application can specify any of the following error actions:

• NULL
  Restores the error handling action to the default of no action.

• ADI_REPORT_ERRORS
  Prints a brief message to stdout. The error code is then returned from the function to the application.

• ADI_EXITON_ERRORS
  Prints the error as defined in ADI_REPORT_ERRORS and then invokes exit with a -1 exit code.

• yourhandler
  Pointer to an application function called by AG Access. The following is the error handling function prototype:

DWORD NMSSTDCALL yourhandler( CTAHD ctahd,
DWORD errcode,
char *errortext,
char *func )

ctahd Context incurring the error (this is the same ctahd that the application passed to the function experiencing the error).

errcode Error code as detected by AG Access

errortext Pointer to error textual description (see adiGetErrorText).

func Pointer to the function name in which the error occurred.

AG Access returns to the application whatever is returned from yourhandler. It is recommended that the errcode received is returned.

adiGetErrorText

DWORD NMSSTDCALL myErrorHandler( CTAHD  ctahd, DWORD errorcode,
                                 char *errtxt, char *func )
{
    /* Just print out the error for debugging. */
    printf( "myErrorHandler: %s on ctahd=%#x, %s\n", errtxt, ctahd, func );
    return errorcode;                   /* pass along to application */
}


void mySetErrorHandler( void )
{
    adiSetErrorHandler( myErrorHandler );
}