group__kim__preferences__reference.html [plain text]
<!-- #bbinclude "header.txt"
#PAGETITLE#="Kerberos Identity Management: KIM Preferences 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__preferences__reference.html">
<META NAME="keywords" CONTENT="#KEYWORDS#">
<META NAME="description" CONTENT="#DESCRIPTION#">
<TITLE>Kerberos Identity Management: KIM Preferences 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 Preferences 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__preferences__reference.html#g88fba2fb35d73c5905eb21dcfad57578">kim_preferences_create</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> *out_preferences)
<dl class="el"><dd class="mdescRight">Create a new preferences object from the current user's preferences. <a href="#g88fba2fb35d73c5905eb21dcfad57578"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#g6075365366f37db89090cc68ad2e5a61">kim_preferences_copy</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> *out_preferences, <a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> in_preferences)
<dl class="el"><dd class="mdescRight">Copy a preferences object. <a href="#g6075365366f37db89090cc68ad2e5a61"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#ge7f0f13dd6d50e7730205abddb1a0127">kim_preferences_set_options</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> io_preferences, <a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options)
<dl class="el"><dd class="mdescRight">Set the user's preferred options. <a href="#ge7f0f13dd6d50e7730205abddb1a0127"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#g634a03cb1109362db8e4024b055afa71">kim_preferences_get_options</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> in_preferences, <a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> *out_options)
<dl class="el"><dd class="mdescRight">Get the user's preferred options. <a href="#g634a03cb1109362db8e4024b055afa71"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#g7e2031a5a8ef5590357b304eb943f402">kim_preferences_set_remember_options</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> io_preferences, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> in_remember_options)
<dl class="el"><dd class="mdescRight">Set whether or not to remember the last options the user used to acquire a credential. <a href="#g7e2031a5a8ef5590357b304eb943f402"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#g804eb8078e5b5a1c73e7e27b0efdb66d">kim_preferences_get_remember_options</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> *out_remember_options)
<dl class="el"><dd class="mdescRight">Get whether or not to remember the last options the user used to acquire a credential. <a href="#g804eb8078e5b5a1c73e7e27b0efdb66d"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#g70806a8dfdde27746f8c161b4f845ecb">kim_preferences_set_client_identity</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> io_preferences, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> in_client_identity)
<dl class="el"><dd class="mdescRight">Set the user's preferred client identity. <a href="#g70806a8dfdde27746f8c161b4f845ecb"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#ga7bf4c87813bee177d2485d827c59943">kim_preferences_get_client_identity</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> *out_client_identity)
<dl class="el"><dd class="mdescRight">Get the user's preferred client identity. <a href="#ga7bf4c87813bee177d2485d827c59943"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#ge8d68790339f8f11f1e017726101329a">kim_preferences_set_remember_client_identity</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> io_preferences, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> in_remember_client_identity)
<dl class="el"><dd class="mdescRight">Set whether or not to remember the last client identity the user acquired a credential for. <a href="#ge8d68790339f8f11f1e017726101329a"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#gd24a4831e3664ae2ec69b2de2ccfca50">kim_preferences_get_remember_client_identity</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> *out_remember_client_identity)
<dl class="el"><dd class="mdescRight">Get whether or not to remember the last client identity the user acquired a credential for. <a href="#gd24a4831e3664ae2ec69b2de2ccfca50"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#gab23bf8c419a21a6fe5a006875eaa5a1">kim_preferences_set_favorite_realms</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> io_preferences, <a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> in_favorite_realms)
<dl class="el"><dd class="mdescRight">Set the user's preferred list of realms. <a href="#gab23bf8c419a21a6fe5a006875eaa5a1"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#g8830e09ce0640497fa994bd0774c2083">kim_preferences_get_favorite_realms</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> in_preferences, <a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> *out_favorite_realms)
<dl class="el"><dd class="mdescRight">Get the user's preferred list of realms. <a href="#g8830e09ce0640497fa994bd0774c2083"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__preferences__reference.html#gd4548bdc2cd52ad21d7a3e1bb60edba0">kim_preferences_synchronize</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> in_preferences)
<dl class="el"><dd class="mdescRight">Synchronize a preferences object with the user's preferences, writing pending changes and reading any changes applied by other processes. <a href="#gd4548bdc2cd52ad21d7a3e1bb60edba0"></a><br></dl><li>void <a class="el" href="group__kim__preferences__reference.html#g4ecf102531d917a0776f563101b8056e">kim_preferences_free</a> (<a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> *io_preferences)
<dl class="el"><dd class="mdescRight">Free memory associated with a preferences object. <a href="#g4ecf102531d917a0776f563101b8056e"></a><br></dl></ul>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g88fba2fb35d73c5905eb21dcfad57578"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_create" ref="g88fba2fb35d73c5905eb21dcfad57578" args="(kim_preferences_t *out_preferences)" --><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_preferences_create </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>out_preferences</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 a new preferences object from the current user's preferences.
<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_preferences</em> </td><td>on exit, a new preferences object. Must be freed with <a class="el" href="group__kim__preferences__reference.html#g4ecf102531d917a0776f563101b8056e">kim_preferences_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="g6075365366f37db89090cc68ad2e5a61"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_copy" ref="g6075365366f37db89090cc68ad2e5a61" args="(kim_preferences_t *out_preferences, kim_preferences_t in_preferences)" --><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_preferences_copy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> * </td>
<td class="mdname" nowrap> <em>out_preferences</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#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>in_preferences</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 a preferences 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>out_preferences</em> </td><td>on exit, a new preferences object which is a copy of in_preferences. Must be freed with <a class="el" href="group__kim__favorite__realms__reference.html#g85ce799724ee0532da5382ab3c6fb571">kim_favorite_realms_free()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences 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="ge7f0f13dd6d50e7730205abddb1a0127"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_options" ref="ge7f0f13dd6d50e7730205abddb1a0127" args="(kim_preferences_t io_preferences, 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_preferences_set_options </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>io_preferences</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>
Set the user's preferred 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>io_preferences</em> </td><td>a preferences object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an 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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g634a03cb1109362db8e4024b055afa71">kim_preferences_get_options()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g634a03cb1109362db8e4024b055afa71"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_options" ref="g634a03cb1109362db8e4024b055afa71" args="(kim_preferences_t in_preferences, 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_preferences_get_options </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>in_preferences</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>out_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>
Get the user's preferred 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>in_preferences</em> </td><td>a preferences object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_options</em> </td><td>on exit, the options specified in <em>in_preferences</em>. 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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#ge7f0f13dd6d50e7730205abddb1a0127">kim_preferences_set_options()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g7e2031a5a8ef5590357b304eb943f402"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_remember_options" ref="g7e2031a5a8ef5590357b304eb943f402" args="(kim_preferences_t io_preferences, kim_boolean_t in_remember_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_preferences_set_remember_options </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>io_preferences</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_remember_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>
Set whether or not to remember the last options the user used to acquire a 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_preferences</em> </td><td>a preferences object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_remember_options</em> </td><td>a boolean value indicating whether or not to remember the last options used to acquire a 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>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g804eb8078e5b5a1c73e7e27b0efdb66d">kim_preferences_get_remember_options()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g804eb8078e5b5a1c73e7e27b0efdb66d"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_remember_options" ref="g804eb8078e5b5a1c73e7e27b0efdb66d" args="(kim_preferences_t in_preferences, kim_boolean_t *out_remember_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_preferences_get_remember_options </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>in_preferences</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_remember_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>
Get whether or not to remember the last options the user used to acquire a 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_preferences</em> </td><td>a preferences object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_remember_options</em> </td><td>on exit, a boolean value indicating whether or <em>in_preferences</em> will remember the last options used to acquire a 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>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g7e2031a5a8ef5590357b304eb943f402">kim_preferences_set_remember_options()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g70806a8dfdde27746f8c161b4f845ecb"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_client_identity" ref="g70806a8dfdde27746f8c161b4f845ecb" args="(kim_preferences_t io_preferences, kim_identity_t in_client_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_preferences_set_client_identity </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>io_preferences</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_client_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 user's preferred client identity.
<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_preferences</em> </td><td>a preferences object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_client_identity</em> </td><td>a client identity 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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#ga7bf4c87813bee177d2485d827c59943">kim_preferences_get_client_identity()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga7bf4c87813bee177d2485d827c59943"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_client_identity" ref="ga7bf4c87813bee177d2485d827c59943" args="(kim_preferences_t in_preferences, kim_identity_t *out_client_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_preferences_get_client_identity </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>in_preferences</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_client_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 user's preferred client identity.
<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_preferences</em> </td><td>a preferences object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_client_identity</em> </td><td>on exit, the client identity specified in <em>in_preferences</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>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g70806a8dfdde27746f8c161b4f845ecb">kim_preferences_set_client_identity()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ge8d68790339f8f11f1e017726101329a"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_remember_client_identity" ref="ge8d68790339f8f11f1e017726101329a" args="(kim_preferences_t io_preferences, kim_boolean_t in_remember_client_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_preferences_set_remember_client_identity </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>io_preferences</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_remember_client_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 whether or not to remember the last client identity the user acquired 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_preferences</em> </td><td>a preferences object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_remember_client_identity</em> </td><td>a boolean value indicating whether or not to remember the last client identity for which a credential was acquired. </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>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#gd24a4831e3664ae2ec69b2de2ccfca50">kim_preferences_get_remember_client_identity()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gd24a4831e3664ae2ec69b2de2ccfca50"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_remember_client_identity" ref="gd24a4831e3664ae2ec69b2de2ccfca50" args="(kim_preferences_t in_preferences, kim_boolean_t *out_remember_client_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_preferences_get_remember_client_identity </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>in_preferences</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_remember_client_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 whether or not to remember the last client identity the user acquired 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_preferences</em> </td><td>a preferences object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_remember_client_identity</em> </td><td>on exit, a boolean value indicating whether or <em>in_preferences</em> will remember the last client identity for which a credential was acquired. </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>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#ge8d68790339f8f11f1e017726101329a">kim_preferences_set_remember_client_identity()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gab23bf8c419a21a6fe5a006875eaa5a1"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_favorite_realms" ref="gab23bf8c419a21a6fe5a006875eaa5a1" args="(kim_preferences_t io_preferences, kim_favorite_realms_t in_favorite_realms)" --><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_preferences_set_favorite_realms </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>io_preferences</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#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> </td>
<td class="mdname" nowrap> <em>in_favorite_realms</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 user's preferred list of realms.
<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_preferences</em> </td><td>a preferences object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_favorite_realms</em> </td><td>a favorite realms object. See <a class="el" href="kim_favorite_realms_overview.html">KIM Favorite Realms Overview</a> for more information on KIM Favorite Realms. </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>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g8830e09ce0640497fa994bd0774c2083">kim_preferences_get_favorite_realms()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g8830e09ce0640497fa994bd0774c2083"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_favorite_realms" ref="g8830e09ce0640497fa994bd0774c2083" args="(kim_preferences_t in_preferences, kim_favorite_realms_t *out_favorite_realms)" --><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_preferences_get_favorite_realms </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname" nowrap> <em>in_preferences</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#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> * </td>
<td class="mdname" nowrap> <em>out_favorite_realms</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 user's preferred list of realms.
<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_preferences</em> </td><td>a preferences object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_favorite_realms</em> </td><td>on exit, a copy of the favorite realms specified in <em>in_preferences</em>. See <a class="el" href="kim_favorite_realms_overview.html">KIM Favorite Realms Overview</a> for more information on KIM Favorite Realms. Must be freed with <a class="el" href="group__kim__favorite__realms__reference.html#g85ce799724ee0532da5382ab3c6fb571">kim_favorite_realms_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>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#gab23bf8c419a21a6fe5a006875eaa5a1">kim_preferences_set_favorite_realms()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gd4548bdc2cd52ad21d7a3e1bb60edba0"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_synchronize" ref="gd4548bdc2cd52ad21d7a3e1bb60edba0" args="(kim_preferences_t in_preferences)" --><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_preferences_synchronize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>in_preferences</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>
Synchronize a preferences object with the user's preferences, writing pending changes and reading any changes applied by other processes.
<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_preferences</em> </td><td>a preferences 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="g4ecf102531d917a0776f563101b8056e"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_free" ref="g4ecf102531d917a0776f563101b8056e" args="(kim_preferences_t *io_preferences)" --><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_preferences_free </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#gdf8ccbcfbb6b79274c31f0ffdf4272eb">kim_preferences_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>io_preferences</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 a preferences 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_preferences</em> </td><td>the preferences 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 -->