Edit File: group__kim__favorite__identities__reference.html
<!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 Favorite Identities 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 Favorite Identities Documentation</h1> <p> <h2>Functions</h2> <ul> <li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__favorite__identities__reference.html#gce53e4a9c9edb531a9e7e26c37e0a5ea">kim_favorite_identities_create</a> (<a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> *out_favorite_identities) <dl class="el"><dd class="mdescRight">Create a new favorite identities list. <a href="#gce53e4a9c9edb531a9e7e26c37e0a5ea"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__favorite__identities__reference.html#g10c6d3516334f6869539972d289f5f6b">kim_favorite_identities_copy</a> (<a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> *out_favorite_identities, <a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> in_favorite_identities) <dl class="el"><dd class="mdescRight">Copy a favorite identities list. <a href="#g10c6d3516334f6869539972d289f5f6b"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__favorite__identities__reference.html#g122519ef11a212852a6045f3f1929fdb">kim_favorite_identities_get_number_of_identities</a> (<a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> in_favorite_identities, <a class="el" href="group__kim__types__reference.html#g709d3d4d2733bc8dc29dcab2e806dd38">kim_count_t</a> *out_number_of_identities) <dl class="el"><dd class="mdescRight">Get the number of identities in a favorite identities list. <a href="#g122519ef11a212852a6045f3f1929fdb"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__favorite__identities__reference.html#gac6ce0a4eaa521fe77b7ae0dbe5097b9">kim_favorite_identities_get_identity_at_index</a> (<a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> in_favorite_identities, <a class="el" href="group__kim__types__reference.html#g709d3d4d2733bc8dc29dcab2e806dd38">kim_count_t</a> in_index, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> *out_identity) <dl class="el"><dd class="mdescRight">Get the Nth identity in a favorite identities list. <a href="#gac6ce0a4eaa521fe77b7ae0dbe5097b9"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__favorite__identities__reference.html#gb298ff23c6e8363d0d34b4c9fdb986e3">kim_favorite_identities_add_identity</a> (<a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> io_favorite_identities, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> in_identity) <dl class="el"><dd class="mdescRight">Add an identity to a favorite identities list. <a href="#gb298ff23c6e8363d0d34b4c9fdb986e3"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__favorite__identities__reference.html#g30b32603f1fa3c1fbb275682620c5d83">kim_favorite_identities_remove_identity</a> (<a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> io_favorite_identities, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> in_identity) <dl class="el"><dd class="mdescRight">Remove an identity from a identities list. <a href="#g30b32603f1fa3c1fbb275682620c5d83"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__favorite__identities__reference.html#g502923d5a9891fb0bb6b75506ce5a8d1">kim_favorite_identities_remove_all_identities</a> (<a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> io_favorite_identities) <dl class="el"><dd class="mdescRight">Empty a favorite identities list. <a href="#g502923d5a9891fb0bb6b75506ce5a8d1"></a><br></dl><li>void <a class="el" href="group__kim__favorite__identities__reference.html#gd4f899dee1067c58f349c6474300c533">kim_favorite_identities_free</a> (<a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> *io_favorite_identities) <dl class="el"><dd class="mdescRight">Free memory associated with an identities list. <a href="#gd4f899dee1067c58f349c6474300c533"></a><br></dl></ul> <hr><h2>Function Documentation</h2> <a class="anchor" name="gce53e4a9c9edb531a9e7e26c37e0a5ea"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_identities_create" ref="gce53e4a9c9edb531a9e7e26c37e0a5ea" args="(kim_favorite_identities_t *out_favorite_identities)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_identities_create </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> * </td> <td class="paramname"> <em>out_favorite_identities</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Create a new favorite identities list. <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_favorite_identities</em> </td><td>on exit, a new favorite identities object. Must be freed with <a class="el" href="group__kim__favorite__identities__reference.html#gd4f899dee1067c58f349c6474300c533" title="Free memory associated with an identities list.">kim_favorite_identities_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 object representing the failure. </dd></dl> </div> </div><p> <a class="anchor" name="g10c6d3516334f6869539972d289f5f6b"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_identities_copy" ref="g10c6d3516334f6869539972d289f5f6b" args="(kim_favorite_identities_t *out_favorite_identities, kim_favorite_identities_t in_favorite_identities)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_identities_copy </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> * </td> <td class="paramname"> <em>out_favorite_identities</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> </td> <td class="paramname"> <em>in_favorite_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> Copy a favorite identities list. <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_favorite_identities</em> </td><td>on exit, a new favorite identities object which is a copy of in_favorite_identities. Must be freed with <a class="el" href="group__kim__favorite__identities__reference.html#gd4f899dee1067c58f349c6474300c533" title="Free memory associated with an identities list.">kim_favorite_identities_free()</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>in_favorite_identities</em> </td><td>a favorite identities 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 object representing the failure. </dd></dl> </div> </div><p> <a class="anchor" name="g122519ef11a212852a6045f3f1929fdb"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_identities_get_number_of_identities" ref="g122519ef11a212852a6045f3f1929fdb" args="(kim_favorite_identities_t in_favorite_identities, kim_count_t *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#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_identities_get_number_of_identities </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> </td> <td class="paramname"> <em>in_favorite_identities</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g709d3d4d2733bc8dc29dcab2e806dd38">kim_count_t</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 identities in a favorite identities list. <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_favorite_identities</em> </td><td>a favorite identities 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_favorite_identities</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 object representing the failure. </dd></dl> </div> </div><p> <a class="anchor" name="gac6ce0a4eaa521fe77b7ae0dbe5097b9"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_identities_get_identity_at_index" ref="gac6ce0a4eaa521fe77b7ae0dbe5097b9" args="(kim_favorite_identities_t in_favorite_identities, kim_count_t in_index, kim_identity_t *out_identity)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_identities_get_identity_at_index </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> </td> <td class="paramname"> <em>in_favorite_identities</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g709d3d4d2733bc8dc29dcab2e806dd38">kim_count_t</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#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> * </td> <td class="paramname"> <em>out_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 Nth identity in a favorite identities list. <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_favorite_identities</em> </td><td>a favorite identities 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_realm</em> </td><td>on exit, the identity at <em>in_index</em> in <em>in_favorite_identities</em>. Must be freed with <a class="el" href="group__kim__string__reference.html#ga3e9ac5bcab38b089adfeebd8ba56ded" title="Free memory associated with a string.">kim_string_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 object representing the failure. </dd></dl> </div> </div><p> <a class="anchor" name="gb298ff23c6e8363d0d34b4c9fdb986e3"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_identities_add_identity" ref="gb298ff23c6e8363d0d34b4c9fdb986e3" args="(kim_favorite_identities_t io_favorite_identities, kim_identity_t in_identity)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_identities_add_identity </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> </td> <td class="paramname"> <em>io_favorite_identities</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</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> Add an identity to a favorite identities list. <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_favorite_identities</em> </td><td>a favorite identities object. </td></tr> <tr><td valign="top"></td><td valign="top"><em>in_identity</em> </td><td>an identity string to add to <em>in_favorite_identities</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 object representing the failure. </dd></dl> </div> </div><p> <a class="anchor" name="g30b32603f1fa3c1fbb275682620c5d83"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_identities_remove_identity" ref="g30b32603f1fa3c1fbb275682620c5d83" args="(kim_favorite_identities_t io_favorite_identities, kim_identity_t in_identity)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_identities_remove_identity </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> </td> <td class="paramname"> <em>io_favorite_identities</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</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 an identity from a identities list. <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_favorite_identities</em> </td><td>a favorite identities object. </td></tr> <tr><td valign="top"></td><td valign="top"><em>in_identity</em> </td><td>an identity to remove from <em>in_favorite_identities</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 object representing the failure. </dd></dl> </div> </div><p> <a class="anchor" name="g502923d5a9891fb0bb6b75506ce5a8d1"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_identities_remove_all_identities" ref="g502923d5a9891fb0bb6b75506ce5a8d1" args="(kim_favorite_identities_t io_favorite_identities)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_identities_remove_all_identities </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> </td> <td class="paramname"> <em>io_favorite_identities</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Empty a favorite identities list. <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_favorite_identities</em> </td><td>a favorite identities 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 object representing the failure. </dd></dl> </div> </div><p> <a class="anchor" name="gd4f899dee1067c58f349c6474300c533"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_identities_free" ref="gd4f899dee1067c58f349c6474300c533" args="(kim_favorite_identities_t *io_favorite_identities)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void kim_favorite_identities_free </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g732f9e24fe1281aa42ffa2b078a53282">kim_favorite_identities_t</a> * </td> <td class="paramname"> <em>io_favorite_identities</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Free memory associated with an identities list. <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_favorite_identities</em> </td><td>the favorite identities 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 Wed May 7 15:22:20 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>
Back to File Manager