1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
<title>Kerberos Identity Management: KIM Preferences Documentation</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
<link href="tabs.css" rel="stylesheet" type="text/css">
7
<!-- Generated by Doxygen 1.5.3 -->
8
<h1>KIM Preferences Documentation</h1>
12
<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)
13
<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)
14
<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)
15
<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)
16
<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)
17
<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)
18
<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)
19
<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)
20
<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)
21
<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)
22
<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)
23
<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)
24
<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)
25
<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)
26
<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)
27
<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)
28
<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)
29
<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)
30
<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)
31
<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)
32
<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)
33
<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)
34
<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)
35
<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)
36
<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)
37
<dl class="el"><dd class="mdescRight">Free memory associated with a preferences object. <a href="#gbc3004692a22355ac2c7d099d18b837f"></a><br></dl></ul>
38
<hr><h2>Function Documentation</h2>
39
<a class="anchor" name="gf1dc483fcb582add046d552da9b8485f"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_create" ref="gf1dc483fcb582add046d552da9b8485f" args="(kim_preferences *out_preferences)" -->
41
<div class="memproto">
42
<table class="memname">
44
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_create </td>
46
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> * </td>
47
<td class="paramname"> <em>out_preferences</em> </td>
48
<td> ) </td>
49
<td width="100%"></td>
56
Create a new preferences object from the current user's preferences.
58
<dl compact><dt><b>Parameters:</b></dt><dd>
59
<table border="0" cellspacing="2" cellpadding="0">
60
<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>
63
<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>
67
<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)" -->
69
<div class="memproto">
70
<table class="memname">
72
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_copy </td>
74
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> * </td>
75
<td class="paramname"> <em>out_preferences</em>, </td>
78
<td class="paramkey"></td>
80
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
81
<td class="paramname"> <em>in_preferences</em></td><td> </td>
86
<td></td><td></td><td width="100%"></td>
93
Copy a preferences object.
95
<dl compact><dt><b>Parameters:</b></dt><dd>
96
<table border="0" cellspacing="2" cellpadding="0">
97
<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>
98
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
101
<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>
105
<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)" -->
106
<div class="memitem">
107
<div class="memproto">
108
<table class="memname">
110
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_options </td>
112
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
113
<td class="paramname"> <em>io_preferences</em>, </td>
116
<td class="paramkey"></td>
118
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> </td>
119
<td class="paramname"> <em>in_options</em></td><td> </td>
124
<td></td><td></td><td width="100%"></td>
131
Set the user's preferred options.
133
<dl compact><dt><b>Parameters:</b></dt><dd>
134
<table border="0" cellspacing="2" cellpadding="0">
135
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object to modify. </td></tr>
136
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>an options object. </td></tr>
139
<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>
140
<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>
144
<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)" -->
145
<div class="memitem">
146
<div class="memproto">
147
<table class="memname">
149
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_options </td>
151
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
152
<td class="paramname"> <em>in_preferences</em>, </td>
155
<td class="paramkey"></td>
157
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> * </td>
158
<td class="paramname"> <em>out_options</em></td><td> </td>
163
<td></td><td></td><td width="100%"></td>
170
Get the user's preferred options.
172
<dl compact><dt><b>Parameters:</b></dt><dd>
173
<table border="0" cellspacing="2" cellpadding="0">
174
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
175
<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>
178
<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>
179
<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>
183
<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)" -->
184
<div class="memitem">
185
<div class="memproto">
186
<table class="memname">
188
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_remember_options </td>
190
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
191
<td class="paramname"> <em>io_preferences</em>, </td>
194
<td class="paramkey"></td>
196
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> </td>
197
<td class="paramname"> <em>in_remember_options</em></td><td> </td>
202
<td></td><td></td><td width="100%"></td>
209
Set whether or not to remember the last options the user used to acquire a credential.
211
<dl compact><dt><b>Parameters:</b></dt><dd>
212
<table border="0" cellspacing="2" cellpadding="0">
213
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object to modify. </td></tr>
214
<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>
217
<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>
218
<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>
222
<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)" -->
223
<div class="memitem">
224
<div class="memproto">
225
<table class="memname">
227
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_remember_options </td>
229
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
230
<td class="paramname"> <em>in_preferences</em>, </td>
233
<td class="paramkey"></td>
235
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> * </td>
236
<td class="paramname"> <em>out_remember_options</em></td><td> </td>
241
<td></td><td></td><td width="100%"></td>
248
Get whether or not to remember the last options the user used to acquire a credential.
250
<dl compact><dt><b>Parameters:</b></dt><dd>
251
<table border="0" cellspacing="2" cellpadding="0">
252
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
253
<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>
256
<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>
257
<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>
261
<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)" -->
262
<div class="memitem">
263
<div class="memproto">
264
<table class="memname">
266
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_client_identity </td>
268
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
269
<td class="paramname"> <em>io_preferences</em>, </td>
272
<td class="paramkey"></td>
274
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> </td>
275
<td class="paramname"> <em>in_client_identity</em></td><td> </td>
280
<td></td><td></td><td width="100%"></td>
287
Set the user's preferred client identity.
289
<dl compact><dt><b>Parameters:</b></dt><dd>
290
<table border="0" cellspacing="2" cellpadding="0">
291
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object to modify. </td></tr>
292
<tr><td valign="top"></td><td valign="top"><em>in_client_identity</em> </td><td>a client identity object. </td></tr>
295
<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>
296
<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>
300
<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)" -->
301
<div class="memitem">
302
<div class="memproto">
303
<table class="memname">
305
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_client_identity </td>
307
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
308
<td class="paramname"> <em>in_preferences</em>, </td>
311
<td class="paramkey"></td>
313
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> * </td>
314
<td class="paramname"> <em>out_client_identity</em></td><td> </td>
319
<td></td><td></td><td width="100%"></td>
326
Get the user's preferred client identity.
328
<dl compact><dt><b>Parameters:</b></dt><dd>
329
<table border="0" cellspacing="2" cellpadding="0">
330
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
331
<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>
334
<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>
335
<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>
339
<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)" -->
340
<div class="memitem">
341
<div class="memproto">
342
<table class="memname">
344
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_remember_client_identity </td>
346
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
347
<td class="paramname"> <em>io_preferences</em>, </td>
350
<td class="paramkey"></td>
352
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> </td>
353
<td class="paramname"> <em>in_remember_client_identity</em></td><td> </td>
358
<td></td><td></td><td width="100%"></td>
365
Set whether or not to remember the last client identity the user acquired a credential for.
367
<dl compact><dt><b>Parameters:</b></dt><dd>
368
<table border="0" cellspacing="2" cellpadding="0">
369
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object to modify. </td></tr>
370
<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>
373
<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>
374
<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>
378
<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)" -->
379
<div class="memitem">
380
<div class="memproto">
381
<table class="memname">
383
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_remember_client_identity </td>
385
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
386
<td class="paramname"> <em>in_preferences</em>, </td>
389
<td class="paramkey"></td>
391
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> * </td>
392
<td class="paramname"> <em>out_remember_client_identity</em></td><td> </td>
397
<td></td><td></td><td width="100%"></td>
404
Get whether or not to remember the last client identity the user acquired a credential for.
406
<dl compact><dt><b>Parameters:</b></dt><dd>
407
<table border="0" cellspacing="2" cellpadding="0">
408
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
409
<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>
412
<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>
413
<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>
417
<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)" -->
418
<div class="memitem">
419
<div class="memproto">
420
<table class="memname">
422
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_minimum_lifetime </td>
424
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
425
<td class="paramname"> <em>io_preferences</em>, </td>
428
<td class="paramkey"></td>
430
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> </td>
431
<td class="paramname"> <em>in_minimum_lifetime</em></td><td> </td>
436
<td></td><td></td><td width="100%"></td>
443
Set the minimum credential lifetime for GUI credential lifetime controls.
445
<dl compact><dt><b>Parameters:</b></dt><dd>
446
<table border="0" cellspacing="2" cellpadding="0">
447
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object to modify. </td></tr>
448
<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>
451
<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>
452
<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>
456
<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)" -->
457
<div class="memitem">
458
<div class="memproto">
459
<table class="memname">
461
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_minimum_lifetime </td>
463
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
464
<td class="paramname"> <em>in_preferences</em>, </td>
467
<td class="paramkey"></td>
469
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> * </td>
470
<td class="paramname"> <em>out_minimum_lifetime</em></td><td> </td>
475
<td></td><td></td><td width="100%"></td>
482
Get the minimum credential lifetime for GUI credential lifetime controls.
484
<dl compact><dt><b>Parameters:</b></dt><dd>
485
<table border="0" cellspacing="2" cellpadding="0">
486
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
487
<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>
490
<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>
491
<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>
495
<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)" -->
496
<div class="memitem">
497
<div class="memproto">
498
<table class="memname">
500
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_maximum_lifetime </td>
502
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
503
<td class="paramname"> <em>io_preferences</em>, </td>
506
<td class="paramkey"></td>
508
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> </td>
509
<td class="paramname"> <em>in_maximum_lifetime</em></td><td> </td>
514
<td></td><td></td><td width="100%"></td>
521
Set the maximum credential lifetime for GUI credential lifetime controls.
523
<dl compact><dt><b>Parameters:</b></dt><dd>
524
<table border="0" cellspacing="2" cellpadding="0">
525
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object to modify. </td></tr>
526
<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>
529
<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>
530
<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>
534
<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)" -->
535
<div class="memitem">
536
<div class="memproto">
537
<table class="memname">
539
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_maximum_lifetime </td>
541
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
542
<td class="paramname"> <em>in_preferences</em>, </td>
545
<td class="paramkey"></td>
547
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> * </td>
548
<td class="paramname"> <em>out_maximum_lifetime</em></td><td> </td>
553
<td></td><td></td><td width="100%"></td>
560
Get the maximum credential lifetime for GUI credential lifetime controls.
562
<dl compact><dt><b>Parameters:</b></dt><dd>
563
<table border="0" cellspacing="2" cellpadding="0">
564
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
565
<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>
568
<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>
569
<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>
573
<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)" -->
574
<div class="memitem">
575
<div class="memproto">
576
<table class="memname">
578
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_minimum_renewal_lifetime </td>
580
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
581
<td class="paramname"> <em>io_preferences</em>, </td>
584
<td class="paramkey"></td>
586
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> </td>
587
<td class="paramname"> <em>in_minimum_renewal_lifetime</em></td><td> </td>
592
<td></td><td></td><td width="100%"></td>
599
Set the minimum credential renewal lifetime for GUI credential lifetime controls.
601
<dl compact><dt><b>Parameters:</b></dt><dd>
602
<table border="0" cellspacing="2" cellpadding="0">
603
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object to modify. </td></tr>
604
<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>
607
<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>
608
<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>
612
<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)" -->
613
<div class="memitem">
614
<div class="memproto">
615
<table class="memname">
617
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_minimum_renewal_lifetime </td>
619
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
620
<td class="paramname"> <em>in_preferences</em>, </td>
623
<td class="paramkey"></td>
625
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> * </td>
626
<td class="paramname"> <em>out_minimum_renewal_lifetime</em></td><td> </td>
631
<td></td><td></td><td width="100%"></td>
638
Get the minimum credential renewal lifetime for GUI credential lifetime controls.
640
<dl compact><dt><b>Parameters:</b></dt><dd>
641
<table border="0" cellspacing="2" cellpadding="0">
642
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
643
<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>
646
<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>
647
<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>
651
<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)" -->
652
<div class="memitem">
653
<div class="memproto">
654
<table class="memname">
656
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_set_maximum_renewal_lifetime </td>
658
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
659
<td class="paramname"> <em>io_preferences</em>, </td>
662
<td class="paramkey"></td>
664
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> </td>
665
<td class="paramname"> <em>in_maximum_renewal_lifetime</em></td><td> </td>
670
<td></td><td></td><td width="100%"></td>
677
Set the maximum credential renewal lifetime for GUI credential lifetime controls.
679
<dl compact><dt><b>Parameters:</b></dt><dd>
680
<table border="0" cellspacing="2" cellpadding="0">
681
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object to modify. </td></tr>
682
<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>
685
<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>
686
<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>
690
<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)" -->
691
<div class="memitem">
692
<div class="memproto">
693
<table class="memname">
695
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_maximum_renewal_lifetime </td>
697
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
698
<td class="paramname"> <em>in_preferences</em>, </td>
701
<td class="paramkey"></td>
703
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g245934c4ef7f94ff7960e20e0cc01123">kim_lifetime</a> * </td>
704
<td class="paramname"> <em>out_maximum_renewal_lifetime</em></td><td> </td>
709
<td></td><td></td><td width="100%"></td>
716
Get the maximum credential renewal lifetime for GUI credential lifetime controls.
718
<dl compact><dt><b>Parameters:</b></dt><dd>
719
<table border="0" cellspacing="2" cellpadding="0">
720
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
721
<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>
724
<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>
725
<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>
729
<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)" -->
730
<div class="memitem">
731
<div class="memproto">
732
<table class="memname">
734
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_number_of_favorite_identities </td>
736
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
737
<td class="paramname"> <em>in_preferences</em>, </td>
740
<td class="paramkey"></td>
742
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g098e3611b2bc3af38b5f06838153165d">kim_count</a> * </td>
743
<td class="paramname"> <em>out_number_of_identities</em></td><td> </td>
748
<td></td><td></td><td width="100%"></td>
755
Get the number of favorite identities in a preferences object.
757
<dl compact><dt><b>Parameters:</b></dt><dd>
758
<table border="0" cellspacing="2" cellpadding="0">
759
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
760
<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>
763
<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>
767
<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)" -->
768
<div class="memitem">
769
<div class="memproto">
770
<table class="memname">
772
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_get_favorite_identity_at_index </td>
774
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
775
<td class="paramname"> <em>in_preferences</em>, </td>
778
<td class="paramkey"></td>
780
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g098e3611b2bc3af38b5f06838153165d">kim_count</a> </td>
781
<td class="paramname"> <em>in_index</em>, </td>
784
<td class="paramkey"></td>
786
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> * </td>
787
<td class="paramname"> <em>out_identity</em>, </td>
790
<td class="paramkey"></td>
792
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> * </td>
793
<td class="paramname"> <em>out_options</em></td><td> </td>
798
<td></td><td></td><td width="100%"></td>
805
Get the Nth favorite identity in a preferences object.
807
<dl compact><dt><b>Parameters:</b></dt><dd>
808
<table border="0" cellspacing="2" cellpadding="0">
809
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
810
<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>
811
<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>
812
<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>
815
<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>
819
<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)" -->
820
<div class="memitem">
821
<div class="memproto">
822
<table class="memname">
824
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_add_favorite_identity </td>
826
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
827
<td class="paramname"> <em>io_preferences</em>, </td>
830
<td class="paramkey"></td>
832
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> </td>
833
<td class="paramname"> <em>in_identity</em>, </td>
836
<td class="paramkey"></td>
838
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gc61f3242847e46c14c73e423829888ab">kim_options</a> </td>
839
<td class="paramname"> <em>in_options</em></td><td> </td>
844
<td></td><td></td><td width="100%"></td>
851
Add a favorite identity to a preferences object.
853
<dl compact><dt><b>Parameters:</b></dt><dd>
854
<table border="0" cellspacing="2" cellpadding="0">
855
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object. </td></tr>
856
<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>
857
<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>
860
<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>
864
<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)" -->
865
<div class="memitem">
866
<div class="memproto">
867
<table class="memname">
869
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_remove_favorite_identity </td>
871
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
872
<td class="paramname"> <em>io_preferences</em>, </td>
875
<td class="paramkey"></td>
877
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gf96cafc394b0d02327b4df8ff669d589">kim_identity</a> </td>
878
<td class="paramname"> <em>in_identity</em></td><td> </td>
883
<td></td><td></td><td width="100%"></td>
890
Remove a favorite identity from a preferences object.
892
<dl compact><dt><b>Parameters:</b></dt><dd>
893
<table border="0" cellspacing="2" cellpadding="0">
894
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object. </td></tr>
895
<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>
898
<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>
902
<a class="anchor" name="gc28596bde36d790f569af33d50feedb8"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_remove_all_favorite_identities" ref="gc28596bde36d790f569af33d50feedb8" args="(kim_preferences io_preferences)" -->
903
<div class="memitem">
904
<div class="memproto">
905
<table class="memname">
907
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_remove_all_favorite_identities </td>
909
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
910
<td class="paramname"> <em>io_preferences</em> </td>
911
<td> ) </td>
912
<td width="100%"></td>
919
Remove all favorite identities in a preferences object.
921
<dl compact><dt><b>Parameters:</b></dt><dd>
922
<table border="0" cellspacing="2" cellpadding="0">
923
<tr><td valign="top"></td><td valign="top"><em>io_preferences</em> </td><td>a preferences object. </td></tr>
926
<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>
930
<a class="anchor" name="g6815e374d78e13714abcddc478145dd9"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_synchronize" ref="g6815e374d78e13714abcddc478145dd9" args="(kim_preferences in_preferences)" -->
931
<div class="memitem">
932
<div class="memproto">
933
<table class="memname">
935
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_preferences_synchronize </td>
937
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> </td>
938
<td class="paramname"> <em>in_preferences</em> </td>
939
<td> ) </td>
940
<td width="100%"></td>
947
Synchronize a preferences object with the user's preferences, writing pending changes and reading any changes applied by other processes.
949
<dl compact><dt><b>Parameters:</b></dt><dd>
950
<table border="0" cellspacing="2" cellpadding="0">
951
<tr><td valign="top"></td><td valign="top"><em>in_preferences</em> </td><td>a preferences object. </td></tr>
954
<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>
958
<a class="anchor" name="gbc3004692a22355ac2c7d099d18b837f"></a><!-- doxytag: member="kim_preferences.h::kim_preferences_free" ref="gbc3004692a22355ac2c7d099d18b837f" args="(kim_preferences *io_preferences)" -->
959
<div class="memitem">
960
<div class="memproto">
961
<table class="memname">
963
<td class="memname">void kim_preferences_free </td>
965
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g2da1f3d3fb0bfbcdd77886a4fd64128c">kim_preferences</a> * </td>
966
<td class="paramname"> <em>io_preferences</em> </td>
967
<td> ) </td>
968
<td width="100%"></td>
975
Free memory associated with a preferences object.
977
<dl compact><dt><b>Parameters:</b></dt><dd>
978
<table border="0" cellspacing="2" cellpadding="0">
979
<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>
985
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 3 17:45:44 2008 for Kerberos Identity Management by
986
<a href="http://www.doxygen.org/index.html">
987
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
added
removed
doc/kim/html/group__kim__preferences__reference.html
