172 lines
6.4 KiB
HTML
172 lines
6.4 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<HTML>
|
||
|
|
<HEAD>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<TITLE>ictxError - Identity Context Error Code Parameter</TITLE>
|
||
|
|
<!-- Begin Header Records ========================================= -->
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- Edited by Kersten Jan 02 -->
|
||
|
|
<!-- Created by Therese Dalton on 17 July 2001 -->
|
||
|
|
<!--File edited for Tidy July 2001 -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</HEAD>
|
||
|
|
<BODY>
|
||
|
|
<!--Java sync-link-->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<A name=Top>
|
||
|
|
</A>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<H2>ictxError--Identity Context Error Code Parameter</H2>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- D E S C R I P T I O N -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<P>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 <a href="#eserver_notes">eServer Implementation
|
||
|
|
Notes</a> for details on platform-specific details for this
|
||
|
|
parameter.
|
||
|
|
</P>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- ictxError structure -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<P>The layout for ictxError follows:</P>
|
||
|
|
<PRE>
|
||
|
|
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;
|
||
|
|
|
||
|
|
</PRE>
|
||
|
|
<BR>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- F I E L D D E S C R I P T I O N S -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<H3>
|
||
|
|
<A name=Header_41>Field Descriptions</A>
|
||
|
|
</H3>
|
||
|
|
<DL>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- returnCode -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>returnCode</STRONG> (Output)
|
||
|
|
<DD>The errno returned for this API. This is the same as the return value for
|
||
|
|
each API.<BR>
|
||
|
|
<BR>
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- additionalInfo -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<DT>
|
||
|
|
<STRONG>additionalInfo</STRONG> (Output)
|
||
|
|
<DD>Additional error information. <BR>
|
||
|
|
<BR>If the <EM>returnCode</EM> value is
|
||
|
|
ICTXERR_EIM (3), then the <EM>additionalInfo</EM> field will contain
|
||
|
|
more details on the EIM error.
|
||
|
|
See the <A href="sec5.htm">Enterprise
|
||
|
|
Identity Mapping (EIM) APIs</A> for a description of the EIM errors.
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- E S E R V E R N O T E S -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<BR>
|
||
|
|
<h3>
|
||
|
|
<a name="eserver_notes">eServer Implementation Notes</a>
|
||
|
|
</h3>
|
||
|
|
<ol>
|
||
|
|
<li>
|
||
|
|
<strong>AIX implementation details:</strong>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
None
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<strong>Linux implementation details:</strong>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
None
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<strong>i5/OS implementation details:</strong><br>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
If the <EM>returnCode</EM> 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. <br>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<strong>Windows implementation details:</strong>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
None
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<strong>z/OS implementation details:</strong><br>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
None
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<!-- The End -->
|
||
|
|
<!-- ============================================================== -->
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center">
|
||
|
|
<a href="#Top_Of_Page">Top</a> |
|
||
|
|
<a href="sec.htm">Security APIs</a> |
|
||
|
|
<a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</BODY>
|
||
|
|
</HTML>
|