group__kim__favorite__realms__reference.html [plain text]
<!-- #bbinclude "header.txt"
#PAGETITLE#="Kerberos Identity Management: KIM Favorite Realms Documentation"
#ADDITIONALSTYLE#="@import url(doxygen.css);"
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
<BASE HREF="http://web.mit.edu/macdev/KfM/KerberosFramework/KerberosIdentityManagement/Documentation/html/group__kim__favorite__realms__reference.html">
<META NAME="keywords" CONTENT="#KEYWORDS#">
<META NAME="description" CONTENT="#DESCRIPTION#">
<TITLE>Kerberos Identity Management: KIM Favorite Realms Documentation</TITLE>
<STYLE TYPE="text/css">
@import url(../../../../Common/Documentation/templates/site.css);
</STYLE>
</HEAD>
<BODY>
<DIV ID="menu">
<IMG SRC="../../../../Common/Documentation/graphics/Kerberos.jpg" ALT="Kerberos for Macintosh Logo">
<HR>
<P><A HREF="../../../../Common/Documentation/index.html">Home</A></P>
<P><A HREF="http://web.mit.edu/kerberos/">MIT Kerberos</A></P>
<P><A HREF="http://web.mit.edu/ist/">MIT IS&T</A></P>
<HR>
<P><A HREF="../../../../Common/Documentation/news.html">News</A></P>
<P><A HREF="../../../../Common/Documentation/documentation.html">Documentation</A></P>
<P><A HREF="../../../../Common/Documentation/developer.html">Developer Resources</A></P>
<P><A HREF="../../../../Common/Documentation/license.html">License</A></P>
<HR>
<P><A HREF="../../../../Common/Documentation/download.html">Download</A></P>
<P><A HREF="../../../../Common/Documentation/support.html">Support</A></P>
<P><A HREF="../../../../Common/Documentation/contact.html">Contact Us</A></P>
</DIV>
<DIV ID="body">
<!-- end bbinclude -->
<!-- Generated by Doxygen 1.4.6 -->
<h1>KIM Favorite Realms 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__realms__reference.html#g417f55b13a783b4577957da31a53802d">kim_favorite_realms_create</a> (<a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> *out_favorite_realms)
<dl class="el"><dd class="mdescRight">Create a new a realms list. <a href="#g417f55b13a783b4577957da31a53802d"></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__realms__reference.html#g6bb1804638e0fb2c713bd45204e19683">kim_favorite_realms_copy</a> (<a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> *out_favorite_realms, <a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> in_favorite_realms)
<dl class="el"><dd class="mdescRight">Copy a realms list. <a href="#g6bb1804638e0fb2c713bd45204e19683"></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__realms__reference.html#g637f34925f3a50f73c92c02b54b00d80">kim_favorite_realms_get_number_of_realms</a> (<a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> in_favorite_realms, <a class="el" href="group__kim__types__reference.html#g709d3d4d2733bc8dc29dcab2e806dd38">kim_count_t</a> *out_number_of_realms)
<dl class="el"><dd class="mdescRight">Get the number of realms in a realms list. <a href="#g637f34925f3a50f73c92c02b54b00d80"></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__realms__reference.html#g9046964d21873704ecfb0cb0a7e45b04">kim_favorite_realms_get_realm_at_index</a> (<a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> in_favorite_realms, <a class="el" href="group__kim__types__reference.html#g306be5b5b238cf2efa36c20edb5073e7">kim_index_t</a> in_index, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> *out_realm)
<dl class="el"><dd class="mdescRight">Get the Nth realm in a realms list. <a href="#g9046964d21873704ecfb0cb0a7e45b04"></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__realms__reference.html#gbd1792ed669426a97c33b6694ed457ad">kim_favorite_realms_add_realm</a> (<a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> io_favorite_realms, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_realm)
<dl class="el"><dd class="mdescRight">Add a realm string to a realms list. <a href="#gbd1792ed669426a97c33b6694ed457ad"></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__realms__reference.html#g86e8863084cd174fa16752e1524ff47e">kim_favorite_realms_remove_realm</a> (<a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> io_favorite_realms, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_realm)
<dl class="el"><dd class="mdescRight">Remove a realm string from a realms list. <a href="#g86e8863084cd174fa16752e1524ff47e"></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__realms__reference.html#g602b4a8fe414d9afa9effe1da51249d9">kim_favorite_realms_remove_all_realms</a> (<a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> io_favorite_realms)
<dl class="el"><dd class="mdescRight">Empty a realms list. <a href="#g602b4a8fe414d9afa9effe1da51249d9"></a><br></dl><li>void <a class="el" href="group__kim__favorite__realms__reference.html#g85ce799724ee0532da5382ab3c6fb571">kim_favorite_realms_free</a> (<a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> *io_favorite_realms)
<dl class="el"><dd class="mdescRight">Free memory associated with a realms list. <a href="#g85ce799724ee0532da5382ab3c6fb571"></a><br></dl></ul>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g417f55b13a783b4577957da31a53802d"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_realms_create" ref="g417f55b13a783b4577957da31a53802d" args="(kim_favorite_realms_t *out_favorite_realms)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_realms_create </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>out_favorite_realms</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a new a realms 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_realms</em> </td><td>on exit, a new favorite realms object. Must be freed with <a class="el" href="group__kim__favorite__realms__reference.html#g85ce799724ee0532da5382ab3c6fb571">kim_favorite_realms_free()</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g6bb1804638e0fb2c713bd45204e19683"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_realms_copy" ref="g6bb1804638e0fb2c713bd45204e19683" args="(kim_favorite_realms_t *out_favorite_realms, kim_favorite_realms_t in_favorite_realms)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_realms_copy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> * </td>
<td class="mdname" nowrap> <em>out_favorite_realms</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> </td>
<td class="mdname" nowrap> <em>in_favorite_realms</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Copy a realms 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_realms</em> </td><td>on exit, a new favorite realms object which is a copy of in_favorite_realms. Must be freed with <a class="el" href="group__kim__favorite__realms__reference.html#g85ce799724ee0532da5382ab3c6fb571">kim_favorite_realms_free()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_favorite_realms</em> </td><td>a favorite realms object. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g637f34925f3a50f73c92c02b54b00d80"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_realms_get_number_of_realms" ref="g637f34925f3a50f73c92c02b54b00d80" args="(kim_favorite_realms_t in_favorite_realms, kim_count_t *out_number_of_realms)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_realms_get_number_of_realms </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> </td>
<td class="mdname" nowrap> <em>in_favorite_realms</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g709d3d4d2733bc8dc29dcab2e806dd38">kim_count_t</a> * </td>
<td class="mdname" nowrap> <em>out_number_of_realms</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the number of realms in a realms 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_realms</em> </td><td>a favorite realms object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_number_of_realms</em> </td><td>on exit, the number of realms in <em>in_favorite_realms</em>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g9046964d21873704ecfb0cb0a7e45b04"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_realms_get_realm_at_index" ref="g9046964d21873704ecfb0cb0a7e45b04" args="(kim_favorite_realms_t in_favorite_realms, kim_index_t in_index, kim_string_t *out_realm)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_realms_get_realm_at_index </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> </td>
<td class="mdname" nowrap> <em>in_favorite_realms</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g306be5b5b238cf2efa36c20edb5073e7">kim_index_t</a> </td>
<td class="mdname" nowrap> <em>in_index</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> * </td>
<td class="mdname" nowrap> <em>out_realm</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the Nth realm in a realms 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_realms</em> </td><td>a favorite realms object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_index</em> </td><td>a index into the realms list (starting at 0). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_realm</em> </td><td>on exit, the realm at <em>in_index</em> in <em>in_favorite_realms</em>. Must be freed with <a class="el" href="group__kim__string__reference.html#ga3e9ac5bcab38b089adfeebd8ba56ded">kim_string_free()</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gbd1792ed669426a97c33b6694ed457ad"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_realms_add_realm" ref="gbd1792ed669426a97c33b6694ed457ad" args="(kim_favorite_realms_t io_favorite_realms, kim_string_t in_realm)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_realms_add_realm </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> </td>
<td class="mdname" nowrap> <em>io_favorite_realms</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> </td>
<td class="mdname" nowrap> <em>in_realm</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add a realm string to a realms 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_realms</em> </td><td>a favorite realms object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_realm</em> </td><td>a realm string to add to <em>in_favorite_realms</em>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g86e8863084cd174fa16752e1524ff47e"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_realms_remove_realm" ref="g86e8863084cd174fa16752e1524ff47e" args="(kim_favorite_realms_t io_favorite_realms, kim_string_t in_realm)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_realms_remove_realm </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> </td>
<td class="mdname" nowrap> <em>io_favorite_realms</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> </td>
<td class="mdname" nowrap> <em>in_realm</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Remove a realm string from a realms 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_realms</em> </td><td>a favorite realms object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_realm</em> </td><td>a realm string to remove from <em>in_favorite_realms</em>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g602b4a8fe414d9afa9effe1da51249d9"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_realms_remove_all_realms" ref="g602b4a8fe414d9afa9effe1da51249d9" args="(kim_favorite_realms_t io_favorite_realms)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_favorite_realms_remove_all_realms </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>io_favorite_realms</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Empty a realms 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_realms</em> </td><td>a favorite realms object. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g85ce799724ee0532da5382ab3c6fb571"></a><!-- doxytag: member="kim_preferences.h::kim_favorite_realms_free" ref="g85ce799724ee0532da5382ab3c6fb571" args="(kim_favorite_realms_t *io_favorite_realms)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void kim_favorite_realms_free </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#ge3f2aae6f1355bc1fdf67b4d729ce92e">kim_favorite_realms_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>io_favorite_realms</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Free memory associated with a realms 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_realms</em> </td><td>the favorite realms object to be freed. Set to NULL on exit. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<!-- #bbinclude "footer.txt" -->
</DIV>
<DIV ID="footer">
<P>
Copyright 2006 Massachusetts Institute of Technology.<BR>
Last updated on $Date: 2006-01-06 20:23:52 -0500 (Fri, 06 Jan 2006) $ <BR>
Last modified by $Author: lxs $
</P>
</DIV>
<!-- Begin MIT-use only web reporting counter -->
<IMG SRC="http://counter.mit.edu/tally" WIDTH=1 HEIGHT=1 ALT="">
<!-- End MIT-use only web reporting counter -->
</BODY></HTML>
<!-- end bbinclude -->