7.8 Error Codes and Handling

(Page 9 of 11 in this chapter)

All AG Access functions return a status code. A SUCCESS (0) return code means either the function completed (synchronous functions) or the function was initiated (asynchronous functions).
A non-zero return code indicates a failure. Asynchronous functions that return a non-zero value are never initiated; therefore, no subsequent events will be generated.
Utility functions are provided for error handling. These help to prototype applications quickly and to diagnose problems with the application program.
The adiSetErrorHandler function is used to define an action if an error occurs within an AG Access function. The application can specify an action to:

Print and return the error code, or

Invoke a user-defined error-handling routine, or

Abort the process.
The action is undertaken before the AG Access function returns to the application.
The error handling functions are listed below:

Function

Description

adiGetErrorText

Returns a text description of AG Access error codes.

adiSetErrorHandler

Defines a new error handler.

adiGetEventText

Returns a text description of an AG Access event code.

(Page 9 of 11 in this chapter)

Copyright 1996 Natural MicroSystems, Inc. All Rights Reserved.