API Error Code Structure (ApiErrC)

Summary

The following is an RPG/LE free-form definition for the IBM API Error Code data structure.

By Dave Clark

The API Error Code data structure

      *========================================================================*
      * IBM API Error Code parameter -- ERRC0100 format
      *
      * NOTE: If supported, including this data structure as a parameter in your
      *       API calls is equivalent to using MONITOR to trap hard errors.  If
      *       an error occurs, it allows the API to pass back the error message
      *       id and any replacement data associated with that message id.
      *
      * DOCUMENTATION:
      * https://www.ibm.com/support/knowledgecenter/en/ssw_ibm_i_72/apiref/error.htm
      *========================================================================*
       dcl-ds ApiErrC        Qualified Inz;
         BytProv             Int(10:0) Inz(%size(ApiErrC));
         BytAvail            Int(10:0);
         MsgId               Char(7);
         Reserved            Char(1);
         MsgData             Char(3000);
       end-ds;