ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/ictxoptions.htm

175 lines
6.1 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>ictxOptions - Identity Context Options 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_Of_Page"></a>
<!-- ============================================================== -->
<!-- -->
<!-- -->
<!-- ============================================================== -->
<H2>ictxOptions--Identity Context Options Parameter</H2>
<!-- ============================================================== -->
<!-- -->
<!-- D E S C R I P T I O N -->
<!-- -->
<!-- ============================================================== -->
<P>This is the options information that can be specified when
storing an identity context or when building an authentication
context.
See <a href="#eserver_notes">eServer Implementation
Notes</a> for details on platform-specific details.
</P>
<!-- ============================================================== -->
<!-- -->
<!-- S T R U C T U R E -->
<!-- -->
<!-- ============================================================== -->
<P>The layout for ictxOptions follows:</P>
<PRE>
typedef struct ictxOptions
{
enum ictxOptionsFormat format;
union
{
ictxOptionsFormat0_t format0;
} options;
} ictxOptions_t;
</PRE>
<P>
<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>
<!-- ============================================================== -->
<!-- format -->
<!-- ============================================================== -->
<DT>
<STRONG>format</STRONG>&nbsp;&nbsp;
<DD>Valid values for the format are:
<PRE>
enum ictxOptionsFormat {
ictx_OPTIONS_FORMAT_0
};
</PRE>
<P>When format is ictx_OPTIONS_FORMAT_0 (0), the <em>options</em> field
must contain an ictxOptionsFormat0_t structure. <BR>
<PRE>
typedef struct ictxOptionsFormat0
{
int timeout;
} ictxOptionsFormat0_t;
</PRE>
<!-- ============================================================== -->
<!-- timeout -->
<!-- ============================================================== -->
<DT>
<STRONG>timeout</STRONG>&nbsp;&nbsp;
<DD>The number of seconds before the object times out.
If -1 is specified, the default value of 3600 seconds is used. Otherwise,
a value of
1 - 3600 seconds must be specified. <BR><BR>
</DD>
</DL>
<BR>
<!-- ============================================================== -->
<!-- -->
<!-- E S E R V E R N O T E S -->
<!-- -->
<!-- ============================================================== -->
<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>
None.
</li>
</ul>
</li>
<li>
<strong>Windows implementation details:</strong>
<ul>
<li>
None.
</li>
</ul>
</li>
<li>
<strong>z/OS implementation notes:</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>