ictxError--Identity Context Error Code Parameter

All Identity Context APIs return an errno. If the ictxError parameter is not NULL, this identity context error code structure contains additional information about the error that was returned. See eServer Implementation Notes for details on platform-specific details for this parameter.

The layout for ictxError follows:

typedef struct ictxError {
    int  returnCode;                /* Same as the errno returned as the
                                     rc for the API                   */
    union {
        ictxEIMError_t  eimError;   /* EIM error information.         */
    } additionalInfo;
} ictxError_t;


typedef struct ictxEIMError {
    int EIMMsgCatalogSetNbr;        /* Message catalog set number     */
    int EIMMsgCatalogMessageID;     /* Message catalog message id     */
} ictxEIMError_t;

Field Descriptions

returnCode  (Output)

The errno returned for this API. This is the same as the return value for each API.

additionalInfo  (Output)

Additional error information.

If the returnCode value is ICTXERR_EIM (3), then the additionalInfo field will contain more details on the EIM error. See the Enterprise Identity Mapping (EIM) APIs for a description of the EIM errors.

eServer Implementation Notes

1. AIX implementation details:
   • None
2. Linux implementation details:
   • None
3. i5/OS implementation details:
   
   • If the returnCode value is ICTXERR_EIM (3), a CPF9898 informational message is written to the job log. The message contains the EIM error information. The EIM message set number and message ID number are for the EIM catalog (/QIBM/PRODDATA/OS400/MRIxxxx/EIM/EIM.CAT). This information can be used to get the error message text from the message catalog.
     
4. Windows implementation details:
   • None
5. z/OS implementation details:
   
   • None