group__kim__types__reference.html   [plain text]


<!-- #bbinclude "header.txt"
  #PAGETITLE#="Kerberos Identity Management: KIM Types and Constants"
  #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__types__reference.html">
  	<META NAME="keywords" CONTENT="#KEYWORDS#">
	<META NAME="description" CONTENT="#DESCRIPTION#">
	<TITLE>Kerberos Identity Management: KIM Types and Constants</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&amp;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 Types and Constants</h1>
<p>
<h2>Defines</h2>
<ul>
<li>#define <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a>) NULL)
<li>#define <a class="el" href="group__kim__types__reference.html#g4c4c33563f8fb12f587a0516437c30e5">KIM_NO_ERROR_ECODE</a>&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#g8db8bb7876c17d07e1e002b89e5a69eb">kim_error_code_t</a>) 0)
<li>#define <a class="el" href="group__kim__types__reference.html#g322f65f7d72470d57e21a4c8777ee9fb">KIM_IDENTITY_ANY</a>&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a>) NULL)
<li>#define <a class="el" href="group__kim__types__reference.html#ge0384d3f6d9108e3ec84e322c61235a7">KIM_OPTIONS_DEFAULT</a>&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a>) NULL)
<li>#define <a class="el" href="group__kim__types__reference.html#g88d98fa3bd4ca00913bff414d65c3590">KIM_OPTIONS_START_IMMEDIATELY</a>&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#g22f06b0741ccb68b739e6395774a53c6">kim_time_t</a>) 0)
</ul>
<h2>Typedefs</h2>
<ul>
<li>typedef uint32_t <a class="el" href="group__kim__types__reference.html#g8d58b8d10d34b30675b1402a12d9fdd1">kim_prompt_type_t</a>
<li>typedef <a class="el" href="group__kim__types__reference.html#g8db8bb7876c17d07e1e002b89e5a69eb">kim_error_code_t</a>(* <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</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_type, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_title, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_message, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_description, void **out_reply)
<li>typedef int32_t <a class="el" href="group__kim__types__reference.html#g8db8bb7876c17d07e1e002b89e5a69eb">kim_error_code_t</a>
<li>typedef int64_t <a class="el" href="group__kim__types__reference.html#g22f06b0741ccb68b739e6395774a53c6">kim_time_t</a>
<li>typedef int64_t <a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a>
<li>typedef uint64_t <a class="el" href="group__kim__types__reference.html#g306be5b5b238cf2efa36c20edb5073e7">kim_index_t</a>
<li>typedef uint64_t <a class="el" href="group__kim__types__reference.html#g709d3d4d2733bc8dc29dcab2e806dd38">kim_count_t</a>
<li>typedef int <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a>
<li>typedef const char * <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a>
<li>typedef kim_error_opaque * <a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a>
<li>typedef kim_identity_opaque * <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a>
<li>typedef kim_options_opaque * <a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a>
<li>typedef kim_selection_hints_opaque * <a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a>
<li>typedef kim_favorite_realms_opaque * <a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a>
<li>typedef kim_preferences_opaque * <a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a>
<li>typedef kim_ccache_iterator_opaque * <a class="el" href="group__kim__types__reference.html#gf19042fb689c87bfbe381654f75af5b9">kim_ccache_iterator_t</a>
<li>typedef kim_ccache_opaque * <a class="el" href="group__kim__types__reference.html#g9fd49877bb2360ab487ffbbbe3342393">kim_ccache_t</a>
<li>typedef kim_credential_iterator_opaque * <a class="el" href="group__kim__types__reference.html#gaf149c8bd856b9067a9f42ccd2afdd37">kim_credential_iterator_t</a>
<li>typedef kim_credential_opaque * <a class="el" href="group__kim__types__reference.html#g0a2be074a5ff409066e73e2db5d6384c">kim_credential_t</a>
</ul>
<h2>Enumerations</h2>
<ul>
<li>enum <b>kim_prompt_type_enum</b> { <b>kim_prompt_type_password</b> =  0, 
<b>kim_prompt_type_challenge</b> =  1
 }
</ul>
<h2>Variables</h2>
<ul>
<li>const <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> <a class="el" href="group__kim__types__reference.html#gf30874b411a7c7308cd496f8531dd6ca">kim_prompt_callback_default</a>
<li>const <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> <a class="el" href="group__kim__types__reference.html#g1e0ff27a769553530b4607995f7ad61d">kim_prompt_callback_gui</a>
<li>const <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> <a class="el" href="group__kim__types__reference.html#g10188dc8e44e579856ff3e2c5768489f">kim_prompt_callback_cli</a>
<li>const <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> <a class="el" href="group__kim__types__reference.html#g682328322dedc851b192118e23dced71">kim_prompt_callback_none</a>
</ul>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="g8712727bab9e6b02712a8a01285441d1"></a><!-- doxytag: member="kim_error.h::KIM_NO_ERROR" ref="g8712727bab9e6b02712a8a01285441d1" args="" --><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">#define KIM_NO_ERROR&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a>) NULL)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The kim_error_t returned when no error occurred. Does not need to be freed with <a class="el" href="group__kim__error__reference.html#gc523758c093a0bb7af18af781e9d182c">kim_error_free()</a>.     </td>
  </tr>
</table>
<a class="anchor" name="g4c4c33563f8fb12f587a0516437c30e5"></a><!-- doxytag: member="kim_error.h::KIM_NO_ERROR_ECODE" ref="g4c4c33563f8fb12f587a0516437c30e5" args="" --><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">#define KIM_NO_ERROR_ECODE&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#g8db8bb7876c17d07e1e002b89e5a69eb">kim_error_code_t</a>) 0)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The kim_error_code_t for KIM_NO_ERROR.     </td>
  </tr>
</table>
<a class="anchor" name="g322f65f7d72470d57e21a4c8777ee9fb"></a><!-- doxytag: member="kim_identity.h::KIM_IDENTITY_ANY" ref="g322f65f7d72470d57e21a4c8777ee9fb" args="" --><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">#define KIM_IDENTITY_ANY&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a>) NULL)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constant to specify any Kerberos identity is acceptable.     </td>
  </tr>
</table>
<a class="anchor" name="ge0384d3f6d9108e3ec84e322c61235a7"></a><!-- doxytag: member="kim_options.h::KIM_OPTIONS_DEFAULT" ref="ge0384d3f6d9108e3ec84e322c61235a7" args="" --><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">#define KIM_OPTIONS_DEFAULT&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a>) NULL)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Specifies the user's default options.     </td>
  </tr>
</table>
<a class="anchor" name="g88d98fa3bd4ca00913bff414d65c3590"></a><!-- doxytag: member="kim_options.h::KIM_OPTIONS_START_IMMEDIATELY" ref="g88d98fa3bd4ca00913bff414d65c3590" args="" --><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">#define KIM_OPTIONS_START_IMMEDIATELY&nbsp;&nbsp;&nbsp;((<a class="el" href="group__kim__types__reference.html#g22f06b0741ccb68b739e6395774a53c6">kim_time_t</a>) 0)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Specifies that credentials should be valid immediately.     </td>
  </tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="g8d58b8d10d34b30675b1402a12d9fdd1"></a><!-- doxytag: member="kim_options.h::kim_prompt_type_t" ref="g8d58b8d10d34b30675b1402a12d9fdd1" args="" --><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">typedef uint32_t <a class="el" href="group__kim__types__reference.html#g8d58b8d10d34b30675b1402a12d9fdd1">kim_prompt_type_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The type of prompt which needs to be displayed. This value determines what type of user interface is displayed. See <a class="el" href="kim_options_overview.html#kim_options_custom_prompt_callback">Providing a Custom Prompt Callback</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g3dc87ed0aa0847e5af0e4f410ba6d7dd"></a><!-- doxytag: member="kim_options.h::kim_prompt_callback_t" ref="g3dc87ed0aa0847e5af0e4f410ba6d7dd" args=")(kim_options_t *io_options, kim_prompt_type_t in_type, kim_string_t in_title, kim_string_t in_message, kim_string_t in_description, void **out_reply)" --><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">typedef <a class="el" href="group__kim__types__reference.html#g8db8bb7876c17d07e1e002b89e5a69eb">kim_error_code_t</a>(* <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</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_type, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_title, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_message, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_description, void **out_reply)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The prompt callback used to display a prompt to the user. See <a class="el" href="kim_options_overview.html#kim_options_custom_prompt_callback">Providing a Custom Prompt Callback</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g8db8bb7876c17d07e1e002b89e5a69eb"></a><!-- doxytag: member="kim_types.h::kim_error_code_t" ref="g8db8bb7876c17d07e1e002b89e5a69eb" args="" --><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">typedef int32_t <a class="el" href="group__kim__types__reference.html#g8db8bb7876c17d07e1e002b89e5a69eb">kim_error_code_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The KIM String type. See <a class="el" href="kim_string_overview.html">KIM String Overview</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g22f06b0741ccb68b739e6395774a53c6"></a><!-- doxytag: member="kim_types.h::kim_time_t" ref="g22f06b0741ccb68b739e6395774a53c6" args="" --><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">typedef int64_t <a class="el" href="group__kim__types__reference.html#g22f06b0741ccb68b739e6395774a53c6">kim_time_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A time value represented in seconds since January 1, 1970.     </td>
  </tr>
</table>
<a class="anchor" name="g1dccbe315455ed55fd34045e3a3e5086"></a><!-- doxytag: member="kim_types.h::kim_lifetime_t" ref="g1dccbe315455ed55fd34045e3a3e5086" args="" --><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">typedef int64_t <a class="el" href="group__kim__types__reference.html#g1dccbe315455ed55fd34045e3a3e5086">kim_lifetime_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A duration represented in seconds.     </td>
  </tr>
</table>
<a class="anchor" name="g306be5b5b238cf2efa36c20edb5073e7"></a><!-- doxytag: member="kim_types.h::kim_index_t" ref="g306be5b5b238cf2efa36c20edb5073e7" args="" --><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">typedef uint64_t <a class="el" href="group__kim__types__reference.html#g306be5b5b238cf2efa36c20edb5073e7">kim_index_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
An 0-based index into an array (ie: zero is the first element in the array).     </td>
  </tr>
</table>
<a class="anchor" name="g709d3d4d2733bc8dc29dcab2e806dd38"></a><!-- doxytag: member="kim_types.h::kim_count_t" ref="g709d3d4d2733bc8dc29dcab2e806dd38" args="" --><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">typedef uint64_t <a class="el" href="group__kim__types__reference.html#g709d3d4d2733bc8dc29dcab2e806dd38">kim_count_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
An quantity, usually used to return the number of elements in an array.     </td>
  </tr>
</table>
<a class="anchor" name="g5a14ff972cd96679e00120c506202d3e"></a><!-- doxytag: member="kim_types.h::kim_boolean_t" ref="g5a14ff972cd96679e00120c506202d3e" args="" --><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">typedef int <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A boolean value. 0 means false, all other values mean true.     </td>
  </tr>
</table>
<a class="anchor" name="g6015e25c120b236938e23290177f5dce"></a><!-- doxytag: member="kim_types.h::kim_string_t" ref="g6015e25c120b236938e23290177f5dce" args="" --><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">typedef const char* <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The KIM String type. See <a class="el" href="kim_string_overview.html">KIM String Overview</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g9e10dd2df80df19496dab049a47514cc"></a><!-- doxytag: member="kim_types.h::kim_error_t" ref="g9e10dd2df80df19496dab049a47514cc" args="" --><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">typedef struct kim_error_opaque* <a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM Error object. See <a class="el" href="kim_error_overview.html">KIM Error Overview</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g24e6b0e3dab12f058c4b2f08113e772a"></a><!-- doxytag: member="kim_types.h::kim_identity_t" ref="g24e6b0e3dab12f058c4b2f08113e772a" args="" --><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">typedef struct kim_identity_opaque* <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM Principal object. See <a class="el" href="kim_identity_overview.html">KIM Identity Overview</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="gae2b9068386ddb47eb075f8a21823d2e"></a><!-- doxytag: member="kim_types.h::kim_options_t" ref="gae2b9068386ddb47eb075f8a21823d2e" args="" --><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">typedef struct kim_options_opaque* <a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM Options object. See <a class="el" href="kim_options_overview.html">KIM Options Overview</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g792f9e97aaf39dd7643221545ff475a3"></a><!-- doxytag: member="kim_types.h::kim_selection_hints_t" ref="g792f9e97aaf39dd7643221545ff475a3" args="" --><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">typedef struct kim_selection_hints_opaque* <a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM Selection Hints object. See <a class="el" href="kim_selection_hints_overview.html">KIM Selection Hints Overview</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="ge3f2aae6f1355bc1fdf67b4d729ce92e"></a><!-- doxytag: member="kim_types.h::kim_favorite_realms_t" ref="ge3f2aae6f1355bc1fdf67b4d729ce92e" args="" --><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">typedef struct kim_favorite_realms_opaque* <a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM Favorite Realms object. See <a class="el" href="kim_favorite_realms_overview.html">KIM Favorite Realms Overview</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="gdf8ccbcfbb6b79274c31f0ffdf4272eb"></a><!-- doxytag: member="kim_types.h::kim_preferences_t" ref="gdf8ccbcfbb6b79274c31f0ffdf4272eb" args="" --><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">typedef struct kim_preferences_opaque* <a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM Preferences object. See <a class="el" href="kim_preferences_overview.html">KIM Preferences Overview</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="gf19042fb689c87bfbe381654f75af5b9"></a><!-- doxytag: member="kim_types.h::kim_ccache_iterator_t" ref="gf19042fb689c87bfbe381654f75af5b9" args="" --><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">typedef struct kim_ccache_iterator_opaque* <a class="el" href="group__kim__types__reference.html#gf19042fb689c87bfbe381654f75af5b9">kim_ccache_iterator_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM CCache Iterator object. See <a class="el" href="kim_ccache_overview.html#kim_credential_cache_collection">Acquiring a CCache from the Cache Collection</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g9fd49877bb2360ab487ffbbbe3342393"></a><!-- doxytag: member="kim_types.h::kim_ccache_t" ref="g9fd49877bb2360ab487ffbbbe3342393" args="" --><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">typedef struct kim_ccache_opaque* <a class="el" href="group__kim__types__reference.html#g9fd49877bb2360ab487ffbbbe3342393">kim_ccache_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM CCache object. See <a class="el" href="kim_ccache_overview.html">KIM CCache Overview</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="gaf149c8bd856b9067a9f42ccd2afdd37"></a><!-- doxytag: member="kim_types.h::kim_credential_iterator_t" ref="gaf149c8bd856b9067a9f42ccd2afdd37" args="" --><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">typedef struct kim_credential_iterator_opaque* <a class="el" href="group__kim__types__reference.html#gaf149c8bd856b9067a9f42ccd2afdd37">kim_credential_iterator_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM Credential Iterator object. See <a class="el" href="kim_credential_overview.html#kim_credential_iterator_t">Iterating over the Credentials in a CCache</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g0a2be074a5ff409066e73e2db5d6384c"></a><!-- doxytag: member="kim_types.h::kim_credential_t" ref="g0a2be074a5ff409066e73e2db5d6384c" args="" --><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">typedef struct kim_credential_opaque* <a class="el" href="group__kim__types__reference.html#g0a2be074a5ff409066e73e2db5d6384c">kim_credential_t</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A KIM Credential object. See <a class="el" href="kim_credential_overview.html">KIM Credential Overview</a> for more information.     </td>
  </tr>
</table>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="gf30874b411a7c7308cd496f8531dd6ca"></a><!-- doxytag: member="kim_options.h::kim_prompt_callback_default" ref="gf30874b411a7c7308cd496f8531dd6ca" args="" --><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">const <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> <a class="el" href="group__kim__types__reference.html#gf30874b411a7c7308cd496f8531dd6ca">kim_prompt_callback_default</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The default prompt callback. See <a class="el" href="kim_options_overview.html#kim_options_custom_prompt_callback">Providing a Custom Prompt Callback</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g1e0ff27a769553530b4607995f7ad61d"></a><!-- doxytag: member="kim_options.h::kim_prompt_callback_gui" ref="g1e0ff27a769553530b4607995f7ad61d" args="" --><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">const <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> <a class="el" href="group__kim__types__reference.html#g1e0ff27a769553530b4607995f7ad61d">kim_prompt_callback_gui</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The graphical prompt callback. See <a class="el" href="kim_options_overview.html#kim_options_custom_prompt_callback">Providing a Custom Prompt Callback</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g10188dc8e44e579856ff3e2c5768489f"></a><!-- doxytag: member="kim_options.h::kim_prompt_callback_cli" ref="g10188dc8e44e579856ff3e2c5768489f" args="" --><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">const <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> <a class="el" href="group__kim__types__reference.html#g10188dc8e44e579856ff3e2c5768489f">kim_prompt_callback_cli</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The command line prompt callback. See <a class="el" href="kim_options_overview.html#kim_options_custom_prompt_callback">Providing a Custom Prompt Callback</a> for more information.     </td>
  </tr>
</table>
<a class="anchor" name="g682328322dedc851b192118e23dced71"></a><!-- doxytag: member="kim_options.h::kim_prompt_callback_none" ref="g682328322dedc851b192118e23dced71" args="" --><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">const <a class="el" href="group__kim__types__reference.html#g3dc87ed0aa0847e5af0e4f410ba6d7dd">kim_prompt_callback_t</a> <a class="el" href="group__kim__types__reference.html#g682328322dedc851b192118e23dced71">kim_prompt_callback_none</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The prompt callback which always returns an error. Use to turn off prompting entirely. <dl compact><dt><b>Note:</b></dt><dd>Using this callback may prevent the user from authenicating. See <a class="el" href="kim_options_overview.html#kim_options_custom_prompt_callback">Providing a Custom Prompt Callback</a> for more information. </dd></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 -->