group__kim__options__reference.html [plain text]
<!-- #bbinclude "header.txt"
#PAGETITLE#="Kerberos Identity Management: KIM Options Reference Documentation"
#ADDITIONALSTYLE#="@import url(doxygen.css);"
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
<BASE HREF="http://web.mit.edu/macdev/KfM/KerberosFramework/KerberosIdentityManagement/Documentation/html/group__kim__options__reference.html">
<META NAME="keywords" CONTENT="#KEYWORDS#">
<META NAME="description" CONTENT="#DESCRIPTION#">
<TITLE>Kerberos Identity Management: KIM Options Reference Documentation</TITLE>
<STYLE TYPE="text/css">
@import url(../../../../Common/Documentation/templates/site.css);
</STYLE>
</HEAD>
<BODY>
<DIV ID="menu">
<IMG SRC="../../../../Common/Documentation/graphics/Kerberos.jpg" ALT="Kerberos for Macintosh Logo">
<HR>
<P><A HREF="../../../../Common/Documentation/index.html">Home</A></P>
<P><A HREF="http://web.mit.edu/kerberos/">MIT Kerberos</A></P>
<P><A HREF="http://web.mit.edu/ist/">MIT IS&T</A></P>
<HR>
<P><A HREF="../../../../Common/Documentation/news.html">News</A></P>
<P><A HREF="../../../../Common/Documentation/documentation.html">Documentation</A></P>
<P><A HREF="../../../../Common/Documentation/developer.html">Developer Resources</A></P>
<P><A HREF="../../../../Common/Documentation/license.html">License</A></P>
<HR>
<P><A HREF="../../../../Common/Documentation/download.html">Download</A></P>
<P><A HREF="../../../../Common/Documentation/support.html">Support</A></P>
<P><A HREF="../../../../Common/Documentation/contact.html">Contact Us</A></P>
</DIV>
<DIV ID="body">
<!-- end bbinclude -->
<!-- Generated by Doxygen 1.4.6 -->
<h1>KIM Options Reference Documentation</h1>
<p>
<h2>Functions</h2>
<ul>
<li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g4d00f4d070409ea90aa69a8ac5cb47cf">kim_options_create</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> *out_options)
<dl class="el"><dd class="mdescRight">Create new options with default values. <a href="#g4d00f4d070409ea90aa69a8ac5cb47cf"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g9581098fcec4c67e4504d90c98dd8d06">kim_options_copy</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> *out_options, <a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options)
<dl class="el"><dd class="mdescRight">Copy options. <a href="#g9581098fcec4c67e4504d90c98dd8d06"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#gb3342e60ebb03f901307fd605af5a684">kim_options_set_prompt_callback</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> in_prompt_callback)
<dl class="el"><dd class="mdescRight">Set the prompt callback for obtaining information from the user. <a href="#gb3342e60ebb03f901307fd605af5a684"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g33ef5b43db39436f16f0c7d80d1860d1">kim_options_get_prompt_callback</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> *out_prompt_callback)
<dl class="el"><dd class="mdescRight">Get the prompt callback for obtaining information from the user. <a href="#g33ef5b43db39436f16f0c7d80d1860d1"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g2668448064e5ff737c7576813aad1996">kim_options_set_data</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, void *in_data)
<dl class="el"><dd class="mdescRight">Set caller-specific data for use in library callbacks. <a href="#g2668448064e5ff737c7576813aad1996"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g48afcd63402d1ac6b61078226b9f14ce">kim_options_get_data</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, void **out_data)
<dl class="el"><dd class="mdescRight">Get caller-specific data for use in library callbacks. <a href="#g48afcd63402d1ac6b61078226b9f14ce"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g55acd6378c0bdf5c534b9535a534c9bd">kim_options_set_prompt_response</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g8d58b8d10d34b30675b1402a12d9fdd1">kim_prompt_type_t</a> in_prompt_type, void *in_response)
<dl class="el"><dd class="mdescRight">Set a response for a prompt for use when acquiring credentials. <a href="#g55acd6378c0bdf5c534b9535a534c9bd"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g7e45337c11734b040c74038f8c2ab21c">kim_options_get_prompt_response</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g8d58b8d10d34b30675b1402a12d9fdd1">kim_prompt_type_t</a> in_prompt_type, void **out_response)
<dl class="el"><dd class="mdescRight">Get the response for a prompt for use when acquiring credentials. <a href="#g7e45337c11734b040c74038f8c2ab21c"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g2193de68adcec22df88069d86e2a145c">kim_options_set_start_time</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g22f06b0741ccb68b739e6395774a53c6">kim_time_t</a> in_start_time)
<dl class="el"><dd class="mdescRight">Set the date when a credential should become valid. <a href="#g2193de68adcec22df88069d86e2a145c"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g587539ca61a06b5730ed688f914e9fa6">kim_options_get_start_time</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g22f06b0741ccb68b739e6395774a53c6">kim_time_t</a> *out_start_time)
<dl class="el"><dd class="mdescRight">Get the date when a credential should become valid. <a href="#g587539ca61a06b5730ed688f914e9fa6"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#ga6058acd016b6387be19e0127606fcb1">kim_options_set_lifetime</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a> in_lifetime)
<dl class="el"><dd class="mdescRight">Set the duration during which a credential should be valid. <a href="#ga6058acd016b6387be19e0127606fcb1"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#gc179cfff2a29eb0bbe4ac0b6dab8afad">kim_options_get_lifetime</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a> *out_lifetime)
<dl class="el"><dd class="mdescRight">Get the duration during which an acquired credential should be valid. <a href="#gc179cfff2a29eb0bbe4ac0b6dab8afad"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g47a49dca419a7d7f1d79c5acd1f16b7a">kim_options_set_renewable</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> in_renewable)
<dl class="el"><dd class="mdescRight">Set whether or not to request a renewable credential. <a href="#g47a49dca419a7d7f1d79c5acd1f16b7a"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#gefc2785f119f04379b20d381a79a45af">kim_options_get_renewable</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> *out_renewable)
<dl class="el"><dd class="mdescRight">Get whether or not to request a renewable credential. <a href="#gefc2785f119f04379b20d381a79a45af"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g035bd3841ff3581922cba91b043cd945">kim_options_set_renewal_lifetime</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a> in_renewal_lifetime)
<dl class="el"><dd class="mdescRight">Set the duration during which a valid credential should be renewable. <a href="#g035bd3841ff3581922cba91b043cd945"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g2a49d92912b6270357788436d2c6fd8f">kim_options_get_renewal_lifetime</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a> *out_renewal_lifetime)
<dl class="el"><dd class="mdescRight">Get the duration during which a valid credential should be renewable. <a href="#g2a49d92912b6270357788436d2c6fd8f"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#gc055fb95bb39e93b276dc2380632cd6d">kim_options_set_forwardable</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> in_forwardable)
<dl class="el"><dd class="mdescRight">Set whether or not to request a forwardable credential. <a href="#gc055fb95bb39e93b276dc2380632cd6d"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g6dc2e2ec0448d28ce847fc8880ce8561">kim_options_get_forwardable</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> *out_forwardable)
<dl class="el"><dd class="mdescRight">Get whether or not to request a forwardable credential. <a href="#g6dc2e2ec0448d28ce847fc8880ce8561"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g4ab6093bff1c28196e2886e146d5e0d0">kim_options_set_proxiable</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> in_proxiable)
<dl class="el"><dd class="mdescRight">Set whether or not to request a proxiable credential. <a href="#g4ab6093bff1c28196e2886e146d5e0d0"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#ga36c948940f89e1cca4477b3d1869c84">kim_options_get_proxiable</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> *out_proxiable)
<dl class="el"><dd class="mdescRight">Get whether or not to request a proxiable credential. <a href="#ga36c948940f89e1cca4477b3d1869c84"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g673640ffd337c815cbc71cbef32b4156">kim_options_set_addressless</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> in_addressless)
<dl class="el"><dd class="mdescRight">Set whether or not to request an addressless credential. <a href="#g673640ffd337c815cbc71cbef32b4156"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g8308f996ae22cad938ec4a4782a01322">kim_options_get_addressless</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> *out_addressless)
<dl class="el"><dd class="mdescRight">Get whether or not to request an addressless credential. <a href="#g8308f996ae22cad938ec4a4782a01322"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g48df00d0dfd94dc37c0b3ec21aed46ac">kim_options_set_service_identity</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> io_options, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> in_service_identity)
<dl class="el"><dd class="mdescRight">Set the service identity to request a credential for. <a href="#g48df00d0dfd94dc37c0b3ec21aed46ac"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__options__reference.html#g1a57d4f84f0e4cfe79d01182bf98f501">kim_options_get_service_identity</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> *out_service_identity)
<dl class="el"><dd class="mdescRight">Get the service identity to request a credential for. <a href="#g1a57d4f84f0e4cfe79d01182bf98f501"></a><br></dl><li>void <a class="el" href="group__kim__options__reference.html#g06130689189d5ba4f9e518c8ed68eb7d">kim_options_free</a> (<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> *io_options)
<dl class="el"><dd class="mdescRight">Free memory associated with an options object. <a href="#g06130689189d5ba4f9e518c8ed68eb7d"></a><br></dl></ul>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g4d00f4d070409ea90aa69a8ac5cb47cf"></a><!-- doxytag: member="kim_options.h::kim_options_create" ref="g4d00f4d070409ea90aa69a8ac5cb47cf" args="(kim_options_t *out_options)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_create </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>out_options</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create new options with default values.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>out_options</em> </td><td>on exit, a new options object. Must be freed with <a class="el" href="group__kim__options__reference.html#g06130689189d5ba4f9e518c8ed68eb7d">kim_options_free()</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g9581098fcec4c67e4504d90c98dd8d06"></a><!-- doxytag: member="kim_options.h::kim_options_copy" ref="g9581098fcec4c67e4504d90c98dd8d06" args="(kim_options_t *out_options, kim_options_t in_options)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_copy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> * </td>
<td class="mdname" nowrap> <em>out_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Copy options.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>out_options</em> </td><td>on exit, a new options object which is a copy of <em>in_options</em>. Must be freed with <a class="el" href="group__kim__options__reference.html#g06130689189d5ba4f9e518c8ed68eb7d">kim_options_free()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>a options object. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gb3342e60ebb03f901307fd605af5a684"></a><!-- doxytag: member="kim_options.h::kim_options_set_prompt_callback" ref="gb3342e60ebb03f901307fd605af5a684" args="(kim_options_t io_options, kim_prompt_callback_t in_prompt_callback)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_prompt_callback </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> </td>
<td class="mdname" nowrap> <em>in_prompt_callback</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the prompt callback for obtaining information from the user.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_prompt_callback</em> </td><td>a prompt callback function. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd><a class="el" href="group__kim__types__reference.html#gf30874b411a7c7308cd496f8531dd6ca">kim_prompt_callback_default</a> </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g33ef5b43db39436f16f0c7d80d1860d1">kim_options_get_prompt_callback()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g33ef5b43db39436f16f0c7d80d1860d1"></a><!-- doxytag: member="kim_options.h::kim_options_get_prompt_callback" ref="g33ef5b43db39436f16f0c7d80d1860d1" args="(kim_options_t in_options, kim_prompt_callback_t *out_prompt_callback)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_prompt_callback </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> * </td>
<td class="mdname" nowrap> <em>out_prompt_callback</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the prompt callback for obtaining information from the user.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_prompt_callback</em> </td><td>on exit, the prompt callback specified by in_options. Does not need to be freed but may become invalid when <em>in_options</em> is freed. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd><a class="el" href="group__kim__types__reference.html#gf30874b411a7c7308cd496f8531dd6ca">kim_prompt_callback_default</a> </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gb3342e60ebb03f901307fd605af5a684">kim_options_set_prompt_callback()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g2668448064e5ff737c7576813aad1996"></a><!-- doxytag: member="kim_options.h::kim_options_set_data" ref="g2668448064e5ff737c7576813aad1996" args="(kim_options_t io_options, void *in_data)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_data </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>in_data</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set caller-specific data for use in library callbacks.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_data</em> </td><td>a pointer to caller-specific data. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This option can be used by the caller to store a pointer to data needed when handling a callback. The KIM library does not use this options data in any way. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>NULL (no data is set by default) </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g48afcd63402d1ac6b61078226b9f14ce">kim_options_get_data()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g48afcd63402d1ac6b61078226b9f14ce"></a><!-- doxytag: member="kim_options.h::kim_options_get_data" ref="g48afcd63402d1ac6b61078226b9f14ce" args="(kim_options_t in_options, void **out_data)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_data </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>void ** </td>
<td class="mdname" nowrap> <em>out_data</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get caller-specific data for use in library callbacks.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_data</em> </td><td>on exit, the pointer to caller specific data specified by in_options. Does not need to be freed but may become invalid when <em>in_options</em> is freed. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This option can be used by the caller to store a pointer to data needed when handling a callback. The KIM library does not use this options data in any way. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>NULL (no data is set by default) </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g2668448064e5ff737c7576813aad1996">kim_options_set_data()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g55acd6378c0bdf5c534b9535a534c9bd"></a><!-- doxytag: member="kim_options.h::kim_options_set_prompt_response" ref="g55acd6378c0bdf5c534b9535a534c9bd" args="(kim_options_t io_options, kim_prompt_type_t in_prompt_type, void *in_response)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_prompt_response </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g8d58b8d10d34b30675b1402a12d9fdd1">kim_prompt_type_t</a> </td>
<td class="mdname" nowrap> <em>in_prompt_type</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>in_response</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set a response for a prompt for use when acquiring credentials.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_prompt_type</em> </td><td>a type of prompt. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_response</em> </td><td>a response to prompts of <em>in_prompt_type</em>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Each response only overrides the first prompt of a given prompt type. If multiple prompts of the same type are required, or if a prompt of a different type is requested, the prompt callback will be called to obtain user input. If you want to turn off prompting entirely, call <a class="el" href="group__kim__options__reference.html#gb3342e60ebb03f901307fd605af5a684">kim_options_set_prompt_callback()</a> with <a class="el" href="group__kim__types__reference.html#g682328322dedc851b192118e23dced71">kim_prompt_callback_none</a>. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>NULL (no response is set by default) </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g7e45337c11734b040c74038f8c2ab21c">kim_options_get_prompt_response()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g7e45337c11734b040c74038f8c2ab21c"></a><!-- doxytag: member="kim_options.h::kim_options_get_prompt_response" ref="g7e45337c11734b040c74038f8c2ab21c" args="(kim_options_t in_options, kim_prompt_type_t in_prompt_type, void **out_response)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_prompt_response </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g8d58b8d10d34b30675b1402a12d9fdd1">kim_prompt_type_t</a> </td>
<td class="mdname" nowrap> <em>in_prompt_type</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>void ** </td>
<td class="mdname" nowrap> <em>out_response</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the response for a prompt for use when acquiring credentials.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_prompt_type</em> </td><td>a type of prompt. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_response</em> </td><td>on exit, the response to prompts of type <em>in_prompt_type</em> specified by <em>in_options</em>. Does not need to be freed but may become invalid when <em>in_options</em> is freed. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>Each response only overrides the first prompt of a given prompt type. If multiple prompts of the same type are required, or if a prompt of a different type is requested, the prompt callback will be called to obtain user input. If you want to turn off prompting entirely, call <a class="el" href="group__kim__options__reference.html#gb3342e60ebb03f901307fd605af5a684">kim_options_set_prompt_callback()</a> with <a class="el" href="group__kim__types__reference.html#g682328322dedc851b192118e23dced71">kim_prompt_callback_none</a>. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>NULL (no response is set by default) </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g55acd6378c0bdf5c534b9535a534c9bd">kim_options_set_prompt_response()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g2193de68adcec22df88069d86e2a145c"></a><!-- doxytag: member="kim_options.h::kim_options_set_start_time" ref="g2193de68adcec22df88069d86e2a145c" args="(kim_options_t io_options, kim_time_t in_start_time)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_start_time </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g22f06b0741ccb68b739e6395774a53c6">kim_time_t</a> </td>
<td class="mdname" nowrap> <em>in_start_time</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the date when a credential should become valid.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_start_time</em> </td><td>a start date (in seconds since January 1, 1970). Set to <a class="el" href="group__kim__types__reference.html#g88d98fa3bd4ca00913bff414d65c3590">KIM_OPTIONS_START_IMMEDIATELY</a> for the acquired credential to be valid immediately. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>When using a start time in the future, once the start time has been reached the credential must be validated before it can be used. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>0, indicating "now". The credential will be valid immediately. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g587539ca61a06b5730ed688f914e9fa6">kim_options_get_start_time()</a>, <a class="el" href="group__kim__credential__reference.html#g9cd6ba59236babb4e79a680fa54b5037">kim_credential_validate()</a>, <a class="el" href="group__kim__ccache__reference.html#g8bb7d46268621e73629dceefd15ff639">kim_ccache_validate()</a>, kim_identity_validate() </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g587539ca61a06b5730ed688f914e9fa6"></a><!-- doxytag: member="kim_options.h::kim_options_get_start_time" ref="g587539ca61a06b5730ed688f914e9fa6" args="(kim_options_t in_options, kim_time_t *out_start_time)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_start_time </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g22f06b0741ccb68b739e6395774a53c6">kim_time_t</a> * </td>
<td class="mdname" nowrap> <em>out_start_time</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the date when a credential should become valid.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_start_time</em> </td><td>on exit, the start date (in seconds since January 1, 1970) specified by <em>in_options</em>. <a class="el" href="group__kim__types__reference.html#g88d98fa3bd4ca00913bff414d65c3590">KIM_OPTIONS_START_IMMEDIATELY</a> indicates the credential will be valid immediately. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>When using a start time in the future, once the start time has been reached the credential must be validated before it can be used. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>0, indicating "now". The credential will be valid immediately. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g2193de68adcec22df88069d86e2a145c">kim_options_set_start_time()</a>, <a class="el" href="group__kim__credential__reference.html#g9cd6ba59236babb4e79a680fa54b5037">kim_credential_validate()</a>, <a class="el" href="group__kim__ccache__reference.html#g8bb7d46268621e73629dceefd15ff639">kim_ccache_validate()</a>, kim_identity_validate() </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga6058acd016b6387be19e0127606fcb1"></a><!-- doxytag: member="kim_options.h::kim_options_set_lifetime" ref="ga6058acd016b6387be19e0127606fcb1" args="(kim_options_t io_options, kim_lifetime_t in_lifetime)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_lifetime </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a> </td>
<td class="mdname" nowrap> <em>in_lifetime</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the duration during which a credential should be valid.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_lifetime</em> </td><td>a lifetime duration (in seconds). </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>KDCs have a maximum allowed lifetime per identity (usually 10 to 21 hours). As a result the credential will actually have a lifetime which is the minimum of <em>in_lifetime</em> and the KDC's maximum allowed lifetime. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gc179cfff2a29eb0bbe4ac0b6dab8afad">kim_options_get_lifetime()</a> </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. 10 hours if unspecified. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gc179cfff2a29eb0bbe4ac0b6dab8afad"></a><!-- doxytag: member="kim_options.h::kim_options_get_lifetime" ref="gc179cfff2a29eb0bbe4ac0b6dab8afad" args="(kim_options_t in_options, kim_lifetime_t *out_lifetime)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_lifetime </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a> * </td>
<td class="mdname" nowrap> <em>out_lifetime</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the duration during which an acquired credential should be valid.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_lifetime</em> </td><td>on exit, the lifetime duration (in seconds) specified in <em>in_options</em>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>KDCs have a maximum allowed lifetime per identity (usually 10 to 21 hours). As a result the credential will actually have a lifetime which is the minimum of <em>in_lifetime</em> and the KDC's maximum allowed lifetime. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. 10 hours if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#ga6058acd016b6387be19e0127606fcb1">kim_options_set_lifetime()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g47a49dca419a7d7f1d79c5acd1f16b7a"></a><!-- doxytag: member="kim_options.h::kim_options_set_renewable" ref="g47a49dca419a7d7f1d79c5acd1f16b7a" args="(kim_options_t io_options, kim_boolean_t in_renewable)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_renewable </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> </td>
<td class="mdname" nowrap> <em>in_renewable</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set whether or not to request a renewable credential.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_renewable</em> </td><td>a boolean value indicating whether or not to request a renewable credential. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gefc2785f119f04379b20d381a79a45af">kim_options_get_renewable()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gefc2785f119f04379b20d381a79a45af"></a><!-- doxytag: member="kim_options.h::kim_options_get_renewable" ref="gefc2785f119f04379b20d381a79a45af" args="(kim_options_t in_options, kim_boolean_t *out_renewable)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_renewable </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> * </td>
<td class="mdname" nowrap> <em>out_renewable</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get whether or not to request a renewable credential.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_renewable</em> </td><td>on exit, a boolean value indicating whether or <em>in_options</em> will request a renewable credential. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g47a49dca419a7d7f1d79c5acd1f16b7a">kim_options_set_renewable()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g035bd3841ff3581922cba91b043cd945"></a><!-- doxytag: member="kim_options.h::kim_options_set_renewal_lifetime" ref="g035bd3841ff3581922cba91b043cd945" args="(kim_options_t io_options, kim_lifetime_t in_renewal_lifetime)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_renewal_lifetime </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a> </td>
<td class="mdname" nowrap> <em>in_renewal_lifetime</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the duration during which a valid credential should be renewable.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_renewal_lifetime</em> </td><td>a renewal lifetime duration (in seconds). </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>KDCs have a maximum allowed renewal lifetime per identity (usually 10 to 21 hours). As a result the credential will actually have a lifetime which is the minimum of <em>in_lifetime</em> and the KDC's maximum allowed lifetime. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. 7 days if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g2a49d92912b6270357788436d2c6fd8f">kim_options_get_renewal_lifetime()</a>, kim_identity_renew(), <a class="el" href="group__kim__credential__reference.html#g99ac2c178bec484311cd7fc2cbb7e05e">kim_credential_renew()</a>, <a class="el" href="group__kim__ccache__reference.html#gafb44675df9d05af5b899996be14e2b4">kim_ccache_renew()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g2a49d92912b6270357788436d2c6fd8f"></a><!-- doxytag: member="kim_options.h::kim_options_get_renewal_lifetime" ref="g2a49d92912b6270357788436d2c6fd8f" args="(kim_options_t in_options, kim_lifetime_t *out_renewal_lifetime)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_renewal_lifetime </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a> * </td>
<td class="mdname" nowrap> <em>out_renewal_lifetime</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the duration during which a valid credential should be renewable.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_renewal_lifetime</em> </td><td>on exit, the renewal lifetime duration (in seconds) specified in <em>in_options</em>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>KDCs have a maximum allowed lifetime per identity (usually 10 to 21 hours). As a result the credential will actually have a lifetime which is the minimum of <em>in_lifetime</em> and the KDC's maximum allowed lifetime. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. 7 days if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g035bd3841ff3581922cba91b043cd945">kim_options_set_renewal_lifetime()</a>, kim_identity_renew(), <a class="el" href="group__kim__credential__reference.html#g99ac2c178bec484311cd7fc2cbb7e05e">kim_credential_renew()</a>, <a class="el" href="group__kim__ccache__reference.html#gafb44675df9d05af5b899996be14e2b4">kim_ccache_renew()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gc055fb95bb39e93b276dc2380632cd6d"></a><!-- doxytag: member="kim_options.h::kim_options_set_forwardable" ref="gc055fb95bb39e93b276dc2380632cd6d" args="(kim_options_t io_options, kim_boolean_t in_forwardable)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_forwardable </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> </td>
<td class="mdname" nowrap> <em>in_forwardable</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set whether or not to request a forwardable credential.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_forwardable</em> </td><td>a boolean value indicating whether or not to request a forwardable credential. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g6dc2e2ec0448d28ce847fc8880ce8561">kim_options_get_forwardable()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g6dc2e2ec0448d28ce847fc8880ce8561"></a><!-- doxytag: member="kim_options.h::kim_options_get_forwardable" ref="g6dc2e2ec0448d28ce847fc8880ce8561" args="(kim_options_t in_options, kim_boolean_t *out_forwardable)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_forwardable </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> * </td>
<td class="mdname" nowrap> <em>out_forwardable</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get whether or not to request a forwardable credential.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_forwardable</em> </td><td>on exit, a boolean value indicating whether or <em>in_options</em> will request a forwardable credential. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#gc055fb95bb39e93b276dc2380632cd6d">kim_options_set_forwardable()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g4ab6093bff1c28196e2886e146d5e0d0"></a><!-- doxytag: member="kim_options.h::kim_options_set_proxiable" ref="g4ab6093bff1c28196e2886e146d5e0d0" args="(kim_options_t io_options, kim_boolean_t in_proxiable)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_proxiable </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> </td>
<td class="mdname" nowrap> <em>in_proxiable</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set whether or not to request a proxiable credential.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_proxiable</em> </td><td>a boolean value indicating whether or not to request a proxiable credential. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#ga36c948940f89e1cca4477b3d1869c84">kim_options_get_proxiable()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga36c948940f89e1cca4477b3d1869c84"></a><!-- doxytag: member="kim_options.h::kim_options_get_proxiable" ref="ga36c948940f89e1cca4477b3d1869c84" args="(kim_options_t in_options, kim_boolean_t *out_proxiable)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_proxiable </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> * </td>
<td class="mdname" nowrap> <em>out_proxiable</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get whether or not to request a proxiable credential.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_proxiable</em> </td><td>on exit, a boolean value indicating whether or <em>in_options</em> will request a proxiable credential. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g4ab6093bff1c28196e2886e146d5e0d0">kim_options_set_proxiable()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g673640ffd337c815cbc71cbef32b4156"></a><!-- doxytag: member="kim_options.h::kim_options_set_addressless" ref="g673640ffd337c815cbc71cbef32b4156" args="(kim_options_t io_options, kim_boolean_t in_addressless)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_addressless </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> </td>
<td class="mdname" nowrap> <em>in_addressless</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set whether or not to request an addressless credential.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_addressless</em> </td><td>a boolean value indicating whether or not to request an addressless credential. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g8308f996ae22cad938ec4a4782a01322">kim_options_get_addressless()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g8308f996ae22cad938ec4a4782a01322"></a><!-- doxytag: member="kim_options.h::kim_options_get_addressless" ref="g8308f996ae22cad938ec4a4782a01322" args="(kim_options_t in_options, kim_boolean_t *out_addressless)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_addressless </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> * </td>
<td class="mdname" nowrap> <em>out_addressless</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get whether or not to request an addressless credential.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_addressless</em> </td><td>on exit, a boolean value indicating whether or <em>in_options</em> will request an addressless credential. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>Read from the user's preferences and the Kerberos configuration. TRUE if unspecified. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g673640ffd337c815cbc71cbef32b4156">kim_options_set_addressless()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g48df00d0dfd94dc37c0b3ec21aed46ac"></a><!-- doxytag: member="kim_options.h::kim_options_set_service_identity" ref="g48df00d0dfd94dc37c0b3ec21aed46ac" args="(kim_options_t io_options, kim_identity_t in_service_identity)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_set_service_identity </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>io_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> </td>
<td class="mdname" nowrap> <em>in_service_identity</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the service identity to request a credential for.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>an options object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_service_identity</em> </td><td>a service identity. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>NULL, indicating "krbtgt@<REALM>", the ticket granting ticket (TGT) service. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g1a57d4f84f0e4cfe79d01182bf98f501">kim_options_get_service_identity()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g1a57d4f84f0e4cfe79d01182bf98f501"></a><!-- doxytag: member="kim_options.h::kim_options_get_service_identity" ref="g1a57d4f84f0e4cfe79d01182bf98f501" args="(kim_options_t in_options, kim_identity_t *out_service_identity)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_options_get_service_identity </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> * </td>
<td class="mdname" nowrap> <em>out_service_identity</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the service identity to request a credential for.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_service_identity</em> </td><td>on exit, the service identity specified in <em>in_options</em>. Must be freed with <a class="el" href="group__kim__identity__reference.html#gd384198163f30b97a6a583ad871a0e23">kim_identity_free()</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Default value</b></dt><dd>NULL, indicating "krbtgt@<REALM>", the ticket granting ticket (TGT) service. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__options__reference.html#g48df00d0dfd94dc37c0b3ec21aed46ac">kim_options_set_service_identity()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g06130689189d5ba4f9e518c8ed68eb7d"></a><!-- doxytag: member="kim_options.h::kim_options_free" ref="g06130689189d5ba4f9e518c8ed68eb7d" args="(kim_options_t *io_options)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void kim_options_free </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>io_options</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Free memory associated with an options object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_options</em> </td><td>the options object to be freed. Set to NULL on exit. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<!-- #bbinclude "footer.txt" -->
</DIV>
<DIV ID="footer">
<P>
Copyright 2006 Massachusetts Institute of Technology.<BR>
Last updated on $Date: 2006-01-06 20:23:52 -0500 (Fri, 06 Jan 2006) $ <BR>
Last modified by $Author: lxs $
</P>
</DIV>
<!-- Begin MIT-use only web reporting counter -->
<IMG SRC="http://counter.mit.edu/tally" WIDTH=1 HEIGHT=1 ALT="">
<!-- End MIT-use only web reporting counter -->
</BODY></HTML>
<!-- end bbinclude -->