Outline API functions return 0 when they succeed; if they fail they return an error status value as defined in esserror.h for C and esberror.bas for Visual Basic. Functions of the main API use the error message callback routine and pass an error number to the message handler. The handler uses the essbase.mdb message database to determine the error message and display an error message to the user.
Outline API functions do not ordinarily use the error message callback routine when returning an error status. The error callback routine is called in the following situations:
If you call functions that use the network (EsxOtlOpenOutline(), EsxOtlWriteOutline(), and EsxOtlRestructure()), and they incur errors on non-outline related actions.
If a NULL is found during routine checking when passed into the Outline API, and API_NULL_ARG is returned.
If a bad outline handle (HOUTLINE) is passed into any call requiring an outline handle, and OTLAPI_BAD_HOUTLINE is returned.