About System Object Access errors

All System Object Access APIs use return codes to report error conditions.

Check for errors on each function call. In addition, certain APIs incorporate a handle to an “error object” in their interface. The error object is used to provide additional information for errors which occurred during the processing of a request. Often these errors are encountered while interacting with the iSeries™ server, in which case the error object will contain the error message text.

If a function call returns CWBSO_ERROR_OCCURRED then the error object will have been filled in with information that describe the error. CWBSO_GetErrMsgText may be used to retrieve the error message text. The message will have been translated into the language that is specified for the user's execution environment. Alternatively, the error message may be displayed to the user directly by calling CWBSO_DisplayErrMsg.

For internal processing errors, error objects automatically log an entry in the System Object Access log file soa.log, in the iSeries Access for Windows® install directory. This file is English only and is intended for use by IBM® personnel for problem analysis.

Related reference
System Object Access APIs return codes