group__kim__preferences__reference.html [plain text]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Kerberos Identity Management: KIM Preferences Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>KIM Preferences Documentation</h1>
<p>
<h2>Functions</h2>
<ul>
<li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#gf1dc483fcb582add046d552da9b8485f">kim_preferences_create</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> *out_preferences)
<dl class="el"><dd class="mdescRight">Create a new preferences object from the current user's preferences. <a href="#gf1dc483fcb582add046d552da9b8485f"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g58ee5520fbae5f7720a70692120de6c2">kim_preferences_copy</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> *out_preferences, <a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences)
<dl class="el"><dd class="mdescRight">Copy a preferences object. <a href="#g58ee5520fbae5f7720a70692120de6c2"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#gc9c1f77fcf571c575664b44267f19fc3">kim_preferences_set_options</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options)
<dl class="el"><dd class="mdescRight">Set the user's preferred options. <a href="#gc9c1f77fcf571c575664b44267f19fc3"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g68f6bb5bd97d85753d74e958e452560f">kim_preferences_get_options</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> *out_options)
<dl class="el"><dd class="mdescRight">Get the user's preferred options. <a href="#g68f6bb5bd97d85753d74e958e452560f"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g9380ffc6ff3d440b680d3d50f8f23f7e">kim_preferences_set_remember_options</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</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="#g9380ffc6ff3d440b680d3d50f8f23f7e"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#ga4b2b54310c0efb6bbba284395095c0f">kim_preferences_get_remember_options</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</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="#ga4b2b54310c0efb6bbba284395095c0f"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g531087a0c7ec0e247eff326066e31b42">kim_preferences_set_client_identity</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> in_client_identity)
<dl class="el"><dd class="mdescRight">Set the user's preferred client identity. <a href="#g531087a0c7ec0e247eff326066e31b42"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g7e8243e83781035aef702b1882114e57">kim_preferences_get_client_identity</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> *out_client_identity)
<dl class="el"><dd class="mdescRight">Get the user's preferred client identity. <a href="#g7e8243e83781035aef702b1882114e57"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#gc956ea12b0f9c82b94e90bfede836af4">kim_preferences_set_remember_client_identity</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</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="#gc956ea12b0f9c82b94e90bfede836af4"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g9113eb1a092a9c745d9b724f7890ecb6">kim_preferences_get_remember_client_identity</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</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="#g9113eb1a092a9c745d9b724f7890ecb6"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g1451680e39e6fba86f01f6166c62a1e0">kim_preferences_set_minimum_lifetime</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> in_minimum_lifetime)
<dl class="el"><dd class="mdescRight">Set the minimum credential lifetime for GUI credential lifetime controls. <a href="#g1451680e39e6fba86f01f6166c62a1e0"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g8da696b824d8cbf6cd97316622edd74e">kim_preferences_get_minimum_lifetime</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> *out_minimum_lifetime)
<dl class="el"><dd class="mdescRight">Get the minimum credential lifetime for GUI credential lifetime controls. <a href="#g8da696b824d8cbf6cd97316622edd74e"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#gb8d2aa65276ab84de1a7ffb7ac59d749">kim_preferences_set_maximum_lifetime</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> in_maximum_lifetime)
<dl class="el"><dd class="mdescRight">Set the maximum credential lifetime for GUI credential lifetime controls. <a href="#gb8d2aa65276ab84de1a7ffb7ac59d749"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#ge7941e46f8a5372c7b2636e3ece8438a">kim_preferences_get_maximum_lifetime</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> *out_maximum_lifetime)
<dl class="el"><dd class="mdescRight">Get the maximum credential lifetime for GUI credential lifetime controls. <a href="#ge7941e46f8a5372c7b2636e3ece8438a"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g578689903e4caf7d0b1c8c00cb822422">kim_preferences_set_minimum_renewal_lifetime</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> in_minimum_renewal_lifetime)
<dl class="el"><dd class="mdescRight">Set the minimum credential renewal lifetime for GUI credential lifetime controls. <a href="#g578689903e4caf7d0b1c8c00cb822422"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g9780ba56efd87ced3ab87f4a172d1ce8">kim_preferences_get_minimum_renewal_lifetime</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> *out_minimum_renewal_lifetime)
<dl class="el"><dd class="mdescRight">Get the minimum credential renewal lifetime for GUI credential lifetime controls. <a href="#g9780ba56efd87ced3ab87f4a172d1ce8"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g2d005064cc3b97f4dd5c4523f869a9d0">kim_preferences_set_maximum_renewal_lifetime</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> in_maximum_renewal_lifetime)
<dl class="el"><dd class="mdescRight">Set the maximum credential renewal lifetime for GUI credential lifetime controls. <a href="#g2d005064cc3b97f4dd5c4523f869a9d0"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#gfd67441a6a6d7063973aac6324bb1577">kim_preferences_get_maximum_renewal_lifetime</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> *out_maximum_renewal_lifetime)
<dl class="el"><dd class="mdescRight">Get the maximum credential renewal lifetime for GUI credential lifetime controls. <a href="#gfd67441a6a6d7063973aac6324bb1577"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g39ff3407953fedfc861efda92f961f18">kim_preferences_get_number_of_favorite_identities</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g098e3611b2bc3af38b5f06838153165d">kim_count</a> *out_number_of_identities)
<dl class="el"><dd class="mdescRight">Get the number of favorite identities in a preferences object. <a href="#g39ff3407953fedfc861efda92f961f18"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g3012077dfb1169ebbbf2d7bf17dbbfdf">kim_preferences_get_favorite_identity_at_index</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> in_preferences, <a class="el" href="group__kim__types__reference.html#g098e3611b2bc3af38b5f06838153165d">kim_count</a> in_index, <a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> *out_identity, <a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> *out_options)
<dl class="el"><dd class="mdescRight">Get the Nth favorite identity in a preferences object. <a href="#g3012077dfb1169ebbbf2d7bf17dbbfdf"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#gd7ed54017b8d46414c550a87ab775a9d">kim_preferences_add_favorite_identity</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> in_identity, <a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> in_options)
<dl class="el"><dd class="mdescRight">Add a favorite identity to a preferences object. <a href="#gd7ed54017b8d46414c550a87ab775a9d"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g85a31ca25607660c9dc2b68527c71f52">kim_preferences_remove_favorite_identity</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences, <a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> in_identity)
<dl class="el"><dd class="mdescRight">Remove a favorite identity from a preferences object. <a href="#g85a31ca25607660c9dc2b68527c71f52"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#gc28596bde36d790f569af33d50feedb8">kim_preferences_remove_all_favorite_identities</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> io_preferences)
<dl class="el"><dd class="mdescRight">Remove all favorite identities in a preferences object. <a href="#gc28596bde36d790f569af33d50feedb8"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__preferences__reference.html#g6815e374d78e13714abcddc478145dd9">kim_preferences_synchronize</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</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="#g6815e374d78e13714abcddc478145dd9"></a><br></dl><li>void <a class="el" href="group__kim__preferences__reference.html#gbc3004692a22355ac2c7d099d18b837f">kim_preferences_free</a> (<a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> *io_preferences)
<dl class="el"><dd class="mdescRight">Free memory associated with a preferences object. <a href="#gbc3004692a22355ac2c7d099d18b837f"></a><br></dl></ul>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gf1dc483fcb582add046d552da9b8485f"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_create" ref="gf1dc483fcb582add046d552da9b8485f" args="(kim_preferences *out_preferences)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> * </td>
<td class="paramname"> <em>out_preferences</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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#gbc3004692a22355ac2c7d099d18b837f" title="Free memory associated with a preferences object.">kim_preferences_free()</a>. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g58ee5520fbae5f7720a70692120de6c2"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_copy" ref="g58ee5520fbae5f7720a70692120de6c2" args="(kim_preferences *out_preferences, kim_preferences in_preferences)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> * </td>
<td class="paramname"> <em>out_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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__preferences__reference.html#gbc3004692a22355ac2c7d099d18b837f" title="Free memory associated with a preferences object.">kim_preferences_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 class="return" 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 code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc9c1f77fcf571c575664b44267f19fc3"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_options" ref="gc9c1f77fcf571c575664b44267f19fc3" args="(kim_preferences io_preferences, kim_options in_options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_options </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> </td>
<td class="paramname"> <em>in_options</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g68f6bb5bd97d85753d74e958e452560f" title="Get the user's preferred options.">kim_preferences_get_options()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g68f6bb5bd97d85753d74e958e452560f"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_options" ref="g68f6bb5bd97d85753d74e958e452560f" args="(kim_preferences in_preferences, kim_options *out_options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_options </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> * </td>
<td class="paramname"> <em>out_options</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>. May be KIM_OPTIONS_DEFAULT. If not, must be freed with <a class="el" href="group__kim__options__reference.html#gd8de9ea0a4eb9e0ffb8e3056a3899f55" title="Free memory associated with an options object.">kim_options_free()</a>. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#gc9c1f77fcf571c575664b44267f19fc3" title="Set the user's preferred options.">kim_preferences_set_options()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g9380ffc6ff3d440b680d3d50f8f23f7e"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_remember_options" ref="g9380ffc6ff3d440b680d3d50f8f23f7e" args="(kim_preferences io_preferences, kim_boolean in_remember_options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_remember_options </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> </td>
<td class="paramname"> <em>in_remember_options</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#ga4b2b54310c0efb6bbba284395095c0f" title="Get whether or not to remember the last options the user used to acquire a credential...">kim_preferences_get_remember_options()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="ga4b2b54310c0efb6bbba284395095c0f"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_remember_options" ref="ga4b2b54310c0efb6bbba284395095c0f" args="(kim_preferences in_preferences, kim_boolean *out_remember_options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_remember_options </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> * </td>
<td class="paramname"> <em>out_remember_options</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g9380ffc6ff3d440b680d3d50f8f23f7e" title="Set whether or not to remember the last options the user used to acquire a credential...">kim_preferences_set_remember_options()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g531087a0c7ec0e247eff326066e31b42"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_client_identity" ref="g531087a0c7ec0e247eff326066e31b42" args="(kim_preferences io_preferences, kim_identity in_client_identity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_client_identity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> </td>
<td class="paramname"> <em>in_client_identity</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g7e8243e83781035aef702b1882114e57" title="Get the user's preferred client identity.">kim_preferences_get_client_identity()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g7e8243e83781035aef702b1882114e57"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_client_identity" ref="g7e8243e83781035aef702b1882114e57" args="(kim_preferences in_preferences, kim_identity *out_client_identity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_client_identity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> * </td>
<td class="paramname"> <em>out_client_identity</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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#g3ae8057f3eb0040330b598645d470411" title="Free memory associated with an identity.">kim_identity_free()</a>. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g531087a0c7ec0e247eff326066e31b42" title="Set the user's preferred client identity.">kim_preferences_set_client_identity()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc956ea12b0f9c82b94e90bfede836af4"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_remember_client_identity" ref="gc956ea12b0f9c82b94e90bfede836af4" args="(kim_preferences io_preferences, kim_boolean in_remember_client_identity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_remember_client_identity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> </td>
<td class="paramname"> <em>in_remember_client_identity</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g9113eb1a092a9c745d9b724f7890ecb6" title="Get whether or not to remember the last client identity the user acquired a credential...">kim_preferences_get_remember_client_identity()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g9113eb1a092a9c745d9b724f7890ecb6"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_remember_client_identity" ref="g9113eb1a092a9c745d9b724f7890ecb6" args="(kim_preferences in_preferences, kim_boolean *out_remember_client_identity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_remember_client_identity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> * </td>
<td class="paramname"> <em>out_remember_client_identity</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#gc956ea12b0f9c82b94e90bfede836af4" title="Set whether or not to remember the last client identity the user acquired a credential...">kim_preferences_set_remember_client_identity()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g1451680e39e6fba86f01f6166c62a1e0"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_minimum_lifetime" ref="g1451680e39e6fba86f01f6166c62a1e0" args="(kim_preferences io_preferences, kim_lifetime in_minimum_lifetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_minimum_lifetime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> </td>
<td class="paramname"> <em>in_minimum_lifetime</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the minimum credential lifetime for GUI credential lifetime controls.
<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_minimum_lifetime</em> </td><td>a minimum lifetime indicating how small a lifetime the GUI tools should allow the user to specify for credentials. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g8da696b824d8cbf6cd97316622edd74e" title="Get the minimum credential lifetime for GUI credential lifetime controls.">kim_preferences_get_minimum_lifetime()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g8da696b824d8cbf6cd97316622edd74e"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_minimum_lifetime" ref="g8da696b824d8cbf6cd97316622edd74e" args="(kim_preferences in_preferences, kim_lifetime *out_minimum_lifetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_minimum_lifetime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> * </td>
<td class="paramname"> <em>out_minimum_lifetime</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the minimum credential lifetime for GUI credential lifetime controls.
<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_minimum_lifetime</em> </td><td>on exit, the minimum lifetime that GUI tools will allow the user to specify for credentials. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g1451680e39e6fba86f01f6166c62a1e0" title="Set the minimum credential lifetime for GUI credential lifetime controls.">kim_preferences_set_minimum_lifetime()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="gb8d2aa65276ab84de1a7ffb7ac59d749"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_maximum_lifetime" ref="gb8d2aa65276ab84de1a7ffb7ac59d749" args="(kim_preferences io_preferences, kim_lifetime in_maximum_lifetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_maximum_lifetime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> </td>
<td class="paramname"> <em>in_maximum_lifetime</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the maximum credential lifetime for GUI credential lifetime controls.
<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_maximum_lifetime</em> </td><td>a maximum lifetime indicating how large a lifetime the GUI tools should allow the user to specify for credentials. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#ge7941e46f8a5372c7b2636e3ece8438a" title="Get the maximum credential lifetime for GUI credential lifetime controls.">kim_preferences_get_maximum_lifetime()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge7941e46f8a5372c7b2636e3ece8438a"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_maximum_lifetime" ref="ge7941e46f8a5372c7b2636e3ece8438a" args="(kim_preferences in_preferences, kim_lifetime *out_maximum_lifetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_maximum_lifetime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> * </td>
<td class="paramname"> <em>out_maximum_lifetime</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the maximum credential lifetime for GUI credential lifetime controls.
<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_maximum_lifetime</em> </td><td>on exit, the maximum lifetime that GUI tools will allow the user to specify for credentials. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#gb8d2aa65276ab84de1a7ffb7ac59d749" title="Set the maximum credential lifetime for GUI credential lifetime controls.">kim_preferences_set_maximum_lifetime()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g578689903e4caf7d0b1c8c00cb822422"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_minimum_renewal_lifetime" ref="g578689903e4caf7d0b1c8c00cb822422" args="(kim_preferences io_preferences, kim_lifetime in_minimum_renewal_lifetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_minimum_renewal_lifetime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> </td>
<td class="paramname"> <em>in_minimum_renewal_lifetime</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the minimum credential renewal lifetime for GUI credential lifetime controls.
<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_minimum_renewal_lifetime</em> </td><td>a minimum lifetime indicating how small a lifetime the GUI tools should allow the user to specify for credential renewal. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g9780ba56efd87ced3ab87f4a172d1ce8" title="Get the minimum credential renewal lifetime for GUI credential lifetime controls...">kim_preferences_get_minimum_renewal_lifetime()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g9780ba56efd87ced3ab87f4a172d1ce8"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_minimum_renewal_lifetime" ref="g9780ba56efd87ced3ab87f4a172d1ce8" args="(kim_preferences in_preferences, kim_lifetime *out_minimum_renewal_lifetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_minimum_renewal_lifetime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> * </td>
<td class="paramname"> <em>out_minimum_renewal_lifetime</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the minimum credential renewal lifetime for GUI credential lifetime controls.
<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_minimum_renewal_lifetime</em> </td><td>on exit, the minimum lifetime that GUI tools will allow the user to specify for credential renewal. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g578689903e4caf7d0b1c8c00cb822422" title="Set the minimum credential renewal lifetime for GUI credential lifetime controls...">kim_preferences_set_minimum_renewal_lifetime()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g2d005064cc3b97f4dd5c4523f869a9d0"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_set_maximum_renewal_lifetime" ref="g2d005064cc3b97f4dd5c4523f869a9d0" args="(kim_preferences io_preferences, kim_lifetime in_maximum_renewal_lifetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_maximum_renewal_lifetime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> </td>
<td class="paramname"> <em>in_maximum_renewal_lifetime</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the maximum credential renewal lifetime for GUI credential lifetime controls.
<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_maximum_renewal_lifetime</em> </td><td>a maximum lifetime indicating how large a lifetime the GUI tools should allow the user to specify for credential renewal. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g9780ba56efd87ced3ab87f4a172d1ce8" title="Get the minimum credential renewal lifetime for GUI credential lifetime controls...">kim_preferences_get_minimum_renewal_lifetime()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="gfd67441a6a6d7063973aac6324bb1577"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_maximum_renewal_lifetime" ref="gfd67441a6a6d7063973aac6324bb1577" args="(kim_preferences in_preferences, kim_lifetime *out_maximum_renewal_lifetime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_maximum_renewal_lifetime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> * </td>
<td class="paramname"> <em>out_maximum_renewal_lifetime</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the maximum credential renewal lifetime for GUI credential lifetime controls.
<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_maximum_renewal_lifetime</em> </td><td>on exit, the maximum lifetime that GUI tools will allow the user to specify for credential renewal. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__preferences__reference.html#g578689903e4caf7d0b1c8c00cb822422" title="Set the minimum credential renewal lifetime for GUI credential lifetime controls...">kim_preferences_set_minimum_renewal_lifetime()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g39ff3407953fedfc861efda92f961f18"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_number_of_favorite_identities" ref="g39ff3407953fedfc861efda92f961f18" args="(kim_preferences in_preferences, kim_count *out_number_of_identities)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_number_of_favorite_identities </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g098e3611b2bc3af38b5f06838153165d">kim_count</a> * </td>
<td class="paramname"> <em>out_number_of_identities</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of favorite identities in 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>in_preferences</em> </td><td>a preferences object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_number_of_identities</em> </td><td>on exit, the number of identities in <em>in_preferences</em>. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3012077dfb1169ebbbf2d7bf17dbbfdf"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_get_favorite_identity_at_index" ref="g3012077dfb1169ebbbf2d7bf17dbbfdf" args="(kim_preferences in_preferences, kim_count in_index, kim_identity *out_identity, kim_options *out_options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_favorite_identity_at_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g098e3611b2bc3af38b5f06838153165d">kim_count</a> </td>
<td class="paramname"> <em>in_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> * </td>
<td class="paramname"> <em>out_identity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> * </td>
<td class="paramname"> <em>out_options</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the Nth favorite identity in 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>in_preferences</em> </td><td>a preferences object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_index</em> </td><td>a index into the identities list (starting at 0). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_identity</em> </td><td>on exit, the identity at <em>in_index</em> in <em>in_preferences</em>. Must be freed with <a class="el" href="group__kim__string__reference.html#g7e7207329022e97473ec71574e52a1fc" title="Free memory associated with a string.">kim_string_free()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_options</em> </td><td>on exit, the options associated with identity at <em>in_index</em> in <em>in_favorite_identities</em>. May be KIM_OPTIONS_DEFAULT. Pass NULL if you do not want the options associated with the identity. Must be freed with <a class="el" href="group__kim__options__reference.html#gd8de9ea0a4eb9e0ffb8e3056a3899f55" title="Free memory associated with an options object.">kim_options_free()</a>. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gd7ed54017b8d46414c550a87ab775a9d"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_add_favorite_identity" ref="gd7ed54017b8d46414c550a87ab775a9d" args="(kim_preferences io_preferences, kim_identity in_identity, kim_options in_options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_add_favorite_identity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> </td>
<td class="paramname"> <em>in_identity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> </td>
<td class="paramname"> <em>in_options</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a favorite identity to 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>a preferences object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_identity</em> </td><td>an identity to add to <em>io_preferences</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>options which will be associated with that identity. Use KIM_OPTIONS_DEFAULT if the identity should use the user's default options. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g85a31ca25607660c9dc2b68527c71f52"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_remove_favorite_identity" ref="g85a31ca25607660c9dc2b68527c71f52" args="(kim_preferences io_preferences, kim_identity in_identity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_remove_favorite_identity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> </td>
<td class="paramname"> <em>in_identity</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a favorite identity from 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>a preferences object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_identity</em> </td><td>an identity to remove from <em>io_preferences</em>. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc28596bde36d790f569af33d50feedb8"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_remove_all_favorite_identities" ref="gc28596bde36d790f569af33d50feedb8" args="(kim_preferences io_preferences)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_remove_all_favorite_identities </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>io_preferences</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove all favorite identities in 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>a preferences object. </td></tr>
</table>
</dl>
<dl class="return" 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 code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g6815e374d78e13714abcddc478145dd9"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_synchronize" ref="g6815e374d78e13714abcddc478145dd9" args="(kim_preferences in_preferences)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_synchronize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
<td class="paramname"> <em>in_preferences</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return" 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 code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gbc3004692a22355ac2c7d099d18b837f"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_free" ref="gbc3004692a22355ac2c7d099d18b837f" args="(kim_preferences *io_preferences)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kim_preferences_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> * </td>
<td class="paramname"> <em>io_preferences</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 3 17:45:44 2008 for Kerberos Identity Management by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>