group__kim__selection__hints__reference.html [plain text]
<!-- #bbinclude "header.txt"
#PAGETITLE#="Kerberos Identity Management: KIM Selection Hints Reference 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__selection__hints__reference.html">
<META NAME="keywords" CONTENT="#KEYWORDS#">
<META NAME="description" CONTENT="#DESCRIPTION#">
<TITLE>Kerberos Identity Management: KIM Selection Hints Reference 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 Selection Hints Reference 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__selection__hints__reference.html#g0b195d5d3baddbb484e4567f395925ea">kim_selection_hints_create</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> *out_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_application_identifier)
<dl class="el"><dd class="mdescRight">Create a new selection hints object. <a href="#g0b195d5d3baddbb484e4567f395925ea"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g3c34975ee97977570750ba4119d34596">kim_selection_hints_copy</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> *out_selection_hints, <a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints)
<dl class="el"><dd class="mdescRight">Copy a selection hints object. <a href="#g3c34975ee97977570750ba4119d34596"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g417690f2b2c671544958c27c934063e6">kim_selection_hints_set_service_identity</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> in_service_identity)
<dl class="el"><dd class="mdescRight">Set the preferred service identity. <a href="#g417690f2b2c671544958c27c934063e6"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g53496d0dc49fa8a634913ce11665a1c9">kim_selection_hints_get_service_identity</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> *out_service_identity)
<dl class="el"><dd class="mdescRight">Get the preferred service identity. <a href="#g53496d0dc49fa8a634913ce11665a1c9"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#gd023c98648d0f7690ad4692cca13e049">kim_selection_hints_set_client_realm</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_client_realm)
<dl class="el"><dd class="mdescRight">Set the preferred client realm. <a href="#gd023c98648d0f7690ad4692cca13e049"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#gdcc8c8960ed6a7068997b452f669da04">kim_selection_hints_get_client_realm</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> *out_client_realm)
<dl class="el"><dd class="mdescRight">Get the preferred client realm. <a href="#gdcc8c8960ed6a7068997b452f669da04"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g6ad7b9eeaeca61da537cbd4bfd5a53a5">kim_selection_hints_set_user</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_user)
<dl class="el"><dd class="mdescRight">Set the preferred user name. <a href="#g6ad7b9eeaeca61da537cbd4bfd5a53a5"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#gde754242dc23ad8b2ddb25114eacede7">kim_selection_hints_get_user</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> *out_user)
<dl class="el"><dd class="mdescRight">Get the preferred user name. <a href="#gde754242dc23ad8b2ddb25114eacede7"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g5e44eef9d1d8b0c3c4d5fbd3595f9644">kim_selection_hints_set_service_realm</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_service_realm)
<dl class="el"><dd class="mdescRight">Set the preferred service realm. <a href="#g5e44eef9d1d8b0c3c4d5fbd3595f9644"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g646fbe6a5a363f4b62ed9923055cf4c6">kim_selection_hints_get_service_realm</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> *out_service_realm)
<dl class="el"><dd class="mdescRight">Get the preferred service realm. <a href="#g646fbe6a5a363f4b62ed9923055cf4c6"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#ga35eb816a82083448e4fab28dc1ca98d">kim_selection_hints_set_service</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_service)
<dl class="el"><dd class="mdescRight">Set the preferred service name. <a href="#ga35eb816a82083448e4fab28dc1ca98d"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g979aa542a6ecb7b3c1437114dfc9d099">kim_selection_hints_get_service</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> *out_service)
<dl class="el"><dd class="mdescRight">Get the preferred service name. <a href="#g979aa542a6ecb7b3c1437114dfc9d099"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g39aac17a30a88cc472b79ba5328e5544">kim_selection_hints_set_hostname</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_hostname)
<dl class="el"><dd class="mdescRight">Set the preferred server host name. <a href="#g39aac17a30a88cc472b79ba5328e5544"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g681a2c9988c74343d2b7f64fecb272b4">kim_selection_hints_get_hostname</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> *out_hostname)
<dl class="el"><dd class="mdescRight">Get the preferred server host name. <a href="#g681a2c9988c74343d2b7f64fecb272b4"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g9904e1b83a1082fbb0752853b3c6ece0">kim_selection_hints_set_application_name</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_application_name)
<dl class="el"><dd class="mdescRight">Set the application name for use in user interaction. <a href="#g9904e1b83a1082fbb0752853b3c6ece0"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#ge254849dd3bf81a295e1e9054220002b">kim_selection_hints_get_application_name</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> *out_application_name)
<dl class="el"><dd class="mdescRight">Get the application name for use in user interaction. <a href="#ge254849dd3bf81a295e1e9054220002b"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#gdde1a442f7ab9913eed7855f06575f92">kim_selection_hints_set_explanation</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> in_explanation)
<dl class="el"><dd class="mdescRight">Set the strings used to prompt the user to select the identity. <a href="#gdde1a442f7ab9913eed7855f06575f92"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#gca2b7379231b656f6ee2df551bb7972e">kim_selection_hints_get_explanation</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g6015e25c120b236938e23290177f5dce">kim_string_t</a> *out_explanation)
<dl class="el"><dd class="mdescRight">Get the strings used to prompt the user to select the identity. <a href="#gca2b7379231b656f6ee2df551bb7972e"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#gae79cd94d2184c8ffe4c7144205fd813">kim_selection_hints_set_options</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> io_selection_hints, <a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> in_options)
<dl class="el"><dd class="mdescRight">Set the options which will be used if credentials need to be acquired. <a href="#gae79cd94d2184c8ffe4c7144205fd813"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#ge00f6f57e9d24d2e62694d72d43148a4">kim_selection_hints_get_options</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> *out_options)
<dl class="el"><dd class="mdescRight">Get the options which will be used if credentials need to be acquired. <a href="#ge00f6f57e9d24d2e62694d72d43148a4"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g8a4f9300250b27fec9b0da4b52f0a781">kim_selection_hints_set_allow_user_interaction</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> in_allow_user_interaction)
<dl class="el"><dd class="mdescRight">Set whether or not KIM may interact with the user to select an identity. <a href="#g8a4f9300250b27fec9b0da4b52f0a781"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g255a01cf3f1e31390b213a802f8b27b4">kim_selection_hints_get_allow_user_interaction</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> *out_allow_user_interaction)
<dl class="el"><dd class="mdescRight">Get whether or not KIM may interact with the user to select an identity. <a href="#g255a01cf3f1e31390b213a802f8b27b4"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g76875288128124ce51be22b2efaadbd1">kim_selection_hints_set_use_cached_results</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> in_use_cached_results)
<dl class="el"><dd class="mdescRight">Set whether or not KIM will cache mappings generated by this selection hints object. <a href="#g76875288128124ce51be22b2efaadbd1"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g03f41c962ad2b1d6225a8d7d450ec53f">kim_selection_hints_get_use_cached_results</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> *out_use_cached_results)
<dl class="el"><dd class="mdescRight">Get whether or not KIM will cache mappings generated by this selection hints object. <a href="#g03f41c962ad2b1d6225a8d7d450ec53f"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g4c18a97d53150f0b3536e52ab884973d">kim_selection_hints_get_identity</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> *out_identity)
<dl class="el"><dd class="mdescRight">Choose a client identity based on selection hints. <a href="#g4c18a97d53150f0b3536e52ab884973d"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g9a9b2ab57d3a9191023231eee8ac2e27">kim_selection_hints_cache_results</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints, <a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> in_identity)
<dl class="el"><dd class="mdescRight">Add an entry for the selection hints to the selection hints cache, replacing any existing entry. <a href="#g9a9b2ab57d3a9191023231eee8ac2e27"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> <a class="el" href="group__kim__selection__hints__reference.html#g19db74acfbbf86d3ea202e5f65f3cb73">kim_selection_hints_forget_cached_results</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> in_selection_hints)
<dl class="el"><dd class="mdescRight">Remove an entry for the selection hints from the selection hints cache. <a href="#g19db74acfbbf86d3ea202e5f65f3cb73"></a><br></dl><li>void <a class="el" href="group__kim__selection__hints__reference.html#g8221dcbf6d972150252707a8d52ad5e5">kim_selection_hints_free</a> (<a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> *io_selection_hints)
<dl class="el"><dd class="mdescRight">Free memory associated with a selection hints object. <a href="#g8221dcbf6d972150252707a8d52ad5e5"></a><br></dl></ul>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g0b195d5d3baddbb484e4567f395925ea"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_create" ref="g0b195d5d3baddbb484e4567f395925ea" args="(kim_selection_hints_t *out_selection_hints, kim_string_t in_application_identifier)" --><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_selection_hints_create </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> * </td>
<td class="mdname" nowrap> <em>out_selection_hints</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_application_identifier</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>
Create a new selection hints object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>out_selection_hints</em> </td><td>on exit, a new selection hints object. Must be freed with <a class="el" href="group__kim__selection__hints__reference.html#g8221dcbf6d972150252707a8d52ad5e5">kim_selection_hints_free()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_application_identifier</em> </td><td>an application identifier string. Java-style identifiers are recommended to avoid cache entry collisions (eg: "com.example.MyApplication") </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="g3c34975ee97977570750ba4119d34596"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_copy" ref="g3c34975ee97977570750ba4119d34596" args="(kim_selection_hints_t *out_selection_hints, kim_selection_hints_t in_selection_hints)" --><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_selection_hints_copy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> * </td>
<td class="mdname" nowrap> <em>out_selection_hints</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#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</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 selection hints object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>out_selection_hints</em> </td><td>on exit, a new selection hints object which is a copy of in_selection_hints. Must be freed with <a class="el" href="group__kim__selection__hints__reference.html#g8221dcbf6d972150252707a8d52ad5e5">kim_selection_hints_free()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_selection_hints</em> </td><td>a selection hints 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="g417690f2b2c671544958c27c934063e6"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_service_identity" ref="g417690f2b2c671544958c27c934063e6" args="(kim_selection_hints_t io_selection_hints, kim_identity_t in_service_identity)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_selection_hints_set_service_identity </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> </td>
<td class="mdname" nowrap> <em>in_service_identity</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the preferred service identity.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_selection_hints</em> </td><td>a selection hints object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_service_identity</em> </td><td>a service identity. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g53496d0dc49fa8a634913ce11665a1c9">kim_selection_hints_get_service_identity()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g53496d0dc49fa8a634913ce11665a1c9"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_service_identity" ref="g53496d0dc49fa8a634913ce11665a1c9" args="(kim_selection_hints_t in_selection_hints, kim_identity_t *out_service_identity)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_selection_hints_get_service_identity </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> * </td>
<td class="mdname" nowrap> <em>out_service_identity</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the preferred service identity.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_selection_hints</em> </td><td>a selection hints object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_service_identity</em> </td><td>on exit, the service identity specified in <em>in_selection_hints</em>. Must be freed with <a class="el" href="group__kim__identity__reference.html#gd384198163f30b97a6a583ad871a0e23">kim_identity_free()</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g417690f2b2c671544958c27c934063e6">kim_selection_hints_set_service_identity()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gd023c98648d0f7690ad4692cca13e049"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_client_realm" ref="gd023c98648d0f7690ad4692cca13e049" args="(kim_selection_hints_t io_selection_hints, kim_string_t in_client_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_selection_hints_set_client_realm </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</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_client_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>
Set the preferred client realm.
<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_selection_hints</em> </td><td>a selection hints object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_client_realm</em> </td><td>a client realm string. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#gdcc8c8960ed6a7068997b452f669da04">kim_selection_hints_get_client_realm()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gdcc8c8960ed6a7068997b452f669da04"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_client_realm" ref="gdcc8c8960ed6a7068997b452f669da04" args="(kim_selection_hints_t io_selection_hints, kim_string_t *out_client_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_selection_hints_get_client_realm </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</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_client_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 preferred client realm.
<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_selection_hints</em> </td><td>a selection hints object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_client_realm</em> </td><td>on exit, the client realm string specified in <em>in_selection_hints</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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#gd023c98648d0f7690ad4692cca13e049">kim_selection_hints_set_client_realm()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g6ad7b9eeaeca61da537cbd4bfd5a53a5"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_user" ref="g6ad7b9eeaeca61da537cbd4bfd5a53a5" args="(kim_selection_hints_t io_selection_hints, kim_string_t in_user)" --><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_selection_hints_set_user </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</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_user</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the preferred user name.
<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_selection_hints</em> </td><td>a selection hints object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_user</em> </td><td>a user name string. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#gde754242dc23ad8b2ddb25114eacede7">kim_selection_hints_get_user()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gde754242dc23ad8b2ddb25114eacede7"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_user" ref="gde754242dc23ad8b2ddb25114eacede7" args="(kim_selection_hints_t in_selection_hints, kim_string_t *out_user)" --><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_selection_hints_get_user </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</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_user</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 preferred user name.
<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_selection_hints</em> </td><td>a selection hints object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_user</em> </td><td>on exit, the user name string specified in <em>in_selection_hints</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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g6ad7b9eeaeca61da537cbd4bfd5a53a5">kim_selection_hints_set_user()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g5e44eef9d1d8b0c3c4d5fbd3595f9644"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_service_realm" ref="g5e44eef9d1d8b0c3c4d5fbd3595f9644" args="(kim_selection_hints_t io_selection_hints, kim_string_t in_service_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_selection_hints_set_service_realm </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</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_service_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>
Set the preferred service realm.
<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_selection_hints</em> </td><td>a selection hints object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_service_realm</em> </td><td>a service realm string. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g646fbe6a5a363f4b62ed9923055cf4c6">kim_selection_hints_get_service_realm()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g646fbe6a5a363f4b62ed9923055cf4c6"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_service_realm" ref="g646fbe6a5a363f4b62ed9923055cf4c6" args="(kim_selection_hints_t io_selection_hints, kim_string_t *out_service_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_selection_hints_get_service_realm </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</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_service_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 preferred service realm.
<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_selection_hints</em> </td><td>a selection hints object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_service_realm</em> </td><td>on exit, the service realm string specified in <em>in_selection_hints</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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g5e44eef9d1d8b0c3c4d5fbd3595f9644">kim_selection_hints_set_service_realm()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga35eb816a82083448e4fab28dc1ca98d"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_service" ref="ga35eb816a82083448e4fab28dc1ca98d" args="(kim_selection_hints_t io_selection_hints, kim_string_t in_service)" --><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_selection_hints_set_service </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</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_service</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the preferred service name.
<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_selection_hints</em> </td><td>a selection hints object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_service</em> </td><td>a service name string. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g979aa542a6ecb7b3c1437114dfc9d099">kim_selection_hints_get_service()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g979aa542a6ecb7b3c1437114dfc9d099"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_service" ref="g979aa542a6ecb7b3c1437114dfc9d099" args="(kim_selection_hints_t in_selection_hints, kim_string_t *out_service)" --><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_selection_hints_get_service </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</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_service</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 preferred service name.
<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_selection_hints</em> </td><td>a selection hints object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_service</em> </td><td>on exit, the service name string specified in <em>in_selection_hints</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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#ga35eb816a82083448e4fab28dc1ca98d">kim_selection_hints_set_service()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g39aac17a30a88cc472b79ba5328e5544"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_hostname" ref="g39aac17a30a88cc472b79ba5328e5544" args="(kim_selection_hints_t io_selection_hints, kim_string_t in_hostname)" --><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_selection_hints_set_hostname </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</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_hostname</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the preferred server host name.
<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_selection_hints</em> </td><td>a selection hints object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_hostname</em> </td><td>a server host name string. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g681a2c9988c74343d2b7f64fecb272b4">kim_selection_hints_get_hostname()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g681a2c9988c74343d2b7f64fecb272b4"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_hostname" ref="g681a2c9988c74343d2b7f64fecb272b4" args="(kim_selection_hints_t in_selection_hints, kim_string_t *out_hostname)" --><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_selection_hints_get_hostname </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</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_hostname</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 preferred server host name.
<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_selection_hints</em> </td><td>a selection hints object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_hostname</em> </td><td>on exit, the server host name string specified in <em>in_selection_hints</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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g39aac17a30a88cc472b79ba5328e5544">kim_selection_hints_set_hostname()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g9904e1b83a1082fbb0752853b3c6ece0"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_application_name" ref="g9904e1b83a1082fbb0752853b3c6ece0" args="(kim_selection_hints_t io_selection_hints, kim_string_t in_application_name)" --><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_selection_hints_set_application_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</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_application_name</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the application name for use in user interaction.
<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_selection_hints</em> </td><td>a selection hints object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_application_name</em> </td><td>a localized string containing the full name of the application. </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>If you do not call this function KIM will attempt to determine the application name at runtime. If that fails (the functionality is only available on some platforms) then KIM will use the application identity string. </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#ge254849dd3bf81a295e1e9054220002b">kim_selection_hints_get_application_name()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ge254849dd3bf81a295e1e9054220002b"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_application_name" ref="ge254849dd3bf81a295e1e9054220002b" args="(kim_selection_hints_t in_selection_hints, kim_string_t *out_application_name)" --><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_selection_hints_get_application_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</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_application_name</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 application name for use in user interaction.
<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_selection_hints</em> </td><td>a selection hints object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_application_name</em> </td><td>on exit, the localized full name of the application specified in <em>in_selection_hints</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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g9904e1b83a1082fbb0752853b3c6ece0">kim_selection_hints_set_application_name()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gdde1a442f7ab9913eed7855f06575f92"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_explanation" ref="gdde1a442f7ab9913eed7855f06575f92" args="(kim_selection_hints_t io_selection_hints, kim_string_t in_explanation)" --><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_selection_hints_set_explanation </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</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_explanation</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the strings used to prompt the user to select the identity.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_selection_hints</em> </td><td>a selection hints object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_explanation</em> </td><td>a localized string describing why the caller needs the identity. </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>If the application only does one thing (the reason it needs an identity is obvious) then you may not need to call this function. You may still need to call <a class="el" href="group__kim__selection__hints__reference.html#g9904e1b83a1082fbb0752853b3c6ece0">kim_selection_hints_set_application_name()</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#gca2b7379231b656f6ee2df551bb7972e">kim_selection_hints_get_explanation()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gca2b7379231b656f6ee2df551bb7972e"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_explanation" ref="gca2b7379231b656f6ee2df551bb7972e" args="(kim_selection_hints_t in_selection_hints, kim_string_t *out_explanation)" --><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_selection_hints_get_explanation </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</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_explanation</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 strings used to prompt the user to select the identity.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_selection_hints</em> </td><td>a selection hints object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_explanation</em> </td><td>on exit, the localized string specified in <em>in_selection_hints</em> which describes why the caller needs the identity. May be NULL. If non-NULL, 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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#gdde1a442f7ab9913eed7855f06575f92">kim_selection_hints_set_explanation()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="gae79cd94d2184c8ffe4c7144205fd813"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_options" ref="gae79cd94d2184c8ffe4c7144205fd813" args="(kim_selection_hints_t io_selection_hints, kim_options_t in_options)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_selection_hints_set_options </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>io_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> </td>
<td class="mdname" nowrap> <em>in_options</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the options which will be used if credentials need to be acquired.
<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_selection_hints</em> </td><td>a selection hints object to modify. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_options</em> </td><td>options to control credential acquisition. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#ge00f6f57e9d24d2e62694d72d43148a4">kim_selection_hints_get_options()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ge00f6f57e9d24d2e62694d72d43148a4"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_options" ref="ge00f6f57e9d24d2e62694d72d43148a4" args="(kim_selection_hints_t in_selection_hints, kim_options_t *out_options)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_selection_hints_get_options </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#gae2b9068386ddb47eb075f8a21823d2e">kim_options_t</a> * </td>
<td class="mdname" nowrap> <em>out_options</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the options which will be used if credentials need to be acquired.
<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_selection_hints</em> </td><td>a selection hints object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_options</em> </td><td>on exit, the options to control credential acquisition specified in <em>in_selection_hints</em>. May be KIM_OPTIONS_DEFAULT. If not, must be freed with <a class="el" href="group__kim__options__reference.html#g06130689189d5ba4f9e518c8ed68eb7d">kim_options_free()</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#gae79cd94d2184c8ffe4c7144205fd813">kim_selection_hints_set_options()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g8a4f9300250b27fec9b0da4b52f0a781"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_allow_user_interaction" ref="g8a4f9300250b27fec9b0da4b52f0a781" args="(kim_selection_hints_t in_selection_hints, kim_boolean_t in_allow_user_interaction)" --><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_selection_hints_set_allow_user_interaction </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> </td>
<td class="mdname" nowrap> <em>in_allow_user_interaction</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set whether or not KIM may interact with the user to select an identity.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_selection_hints</em> </td><td>a selection hints object to modify </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_allow_user_interaction</em> </td><td>a boolean value specifying whether or not KIM should ask the user to select an identity for <em>in_selection_hints</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>
<dl compact><dt><b>Note:</b></dt><dd>This setting defaults to TRUE. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g255a01cf3f1e31390b213a802f8b27b4">kim_selection_hints_get_allow_user_interaction</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g255a01cf3f1e31390b213a802f8b27b4"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_allow_user_interaction" ref="g255a01cf3f1e31390b213a802f8b27b4" args="(kim_selection_hints_t in_selection_hints, kim_boolean_t *out_allow_user_interaction)" --><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_selection_hints_get_allow_user_interaction </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> * </td>
<td class="mdname" nowrap> <em>out_allow_user_interaction</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get whether or not KIM may interact with the user to select an identity.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_selection_hints</em> </td><td>a selection hints object to modify </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_allow_user_interaction</em> </td><td>on exit, a boolean value specifying whether or not KIM should ask the user to select an identity for <em>in_selection_hints</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>
<dl compact><dt><b>Note:</b></dt><dd>This setting defaults to TRUE. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g8a4f9300250b27fec9b0da4b52f0a781">kim_selection_hints_set_allow_user_interaction</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g76875288128124ce51be22b2efaadbd1"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_set_use_cached_results" ref="g76875288128124ce51be22b2efaadbd1" args="(kim_selection_hints_t in_selection_hints, kim_boolean_t in_use_cached_results)" --><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_selection_hints_set_use_cached_results </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> </td>
<td class="mdname" nowrap> <em>in_use_cached_results</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set whether or not KIM will cache mappings generated by this selection hints object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_selection_hints</em> </td><td>a selection hints object to modify </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_use_cached_results</em> </td><td>a boolean value specifying whether or not KIM should use a cached mapping between <em>in_selection_hints</em> and a Kerberos identity. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This setting defaults to TRUE. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g03f41c962ad2b1d6225a8d7d450ec53f">kim_selection_hints_get_use_cached_results</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g03f41c962ad2b1d6225a8d7d450ec53f"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_use_cached_results" ref="g03f41c962ad2b1d6225a8d7d450ec53f" args="(kim_selection_hints_t in_selection_hints, kim_boolean_t *out_use_cached_results)" --><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_selection_hints_get_use_cached_results </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g5a14ff972cd96679e00120c506202d3e">kim_boolean_t</a> * </td>
<td class="mdname" nowrap> <em>out_use_cached_results</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get whether or not KIM will cache mappings generated by this selection hints object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_selection_hints</em> </td><td>a selection hints object to modify </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_use_cached_results</em> </td><td>on exit, a boolean value specifying whether or not KIM will use a cached mapping between <em>in_selection_hints</em> and a Kerberos identity. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This setting defaults to TRUE. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__kim__selection__hints__reference.html#g76875288128124ce51be22b2efaadbd1">kim_selection_hints_set_use_cached_results</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g4c18a97d53150f0b3536e52ab884973d"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_get_identity" ref="g4c18a97d53150f0b3536e52ab884973d" args="(kim_selection_hints_t in_selection_hints, kim_identity_t *out_identity)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_selection_hints_get_identity </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> * </td>
<td class="mdname" nowrap> <em>out_identity</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Choose a client identity based on selection hints.
<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_selection_hints</em> </td><td>the selection hints to add to the cache. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_identity</em> </td><td>the Kerberos identity <em>in_selection_hints</em> maps to. Must be freed with <a class="el" href="group__kim__identity__reference.html#gd384198163f30b97a6a583ad871a0e23">kim_identity_free()</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error object representing the failure. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><em>out_identity</em> is the identity mapped to by the current state of <em>in_selection_hints</em>. This function may prompt the user via a GUI to choose that identity. Subsequent modifications to <em>in_selection_hints</em> will not change <em>out_identity</em>. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="g9a9b2ab57d3a9191023231eee8ac2e27"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_cache_results" ref="g9a9b2ab57d3a9191023231eee8ac2e27" args="(kim_selection_hints_t in_selection_hints, kim_identity_t in_identity)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g9e10dd2df80df19496dab049a47514cc">kim_error_t</a> kim_selection_hints_cache_results </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname" nowrap> <em>in_selection_hints</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__kim__types__reference.html#g24e6b0e3dab12f058c4b2f08113e772a">kim_identity_t</a> </td>
<td class="mdname" nowrap> <em>in_identity</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add an entry for the selection hints to the selection hints cache, replacing any existing entry.
<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_selection_hints</em> </td><td>the selection hints to add to the cache. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_identity</em> </td><td>the Kerberos identity <em>in_selection_hints</em> maps to. </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="g19db74acfbbf86d3ea202e5f65f3cb73"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_forget_cached_results" ref="g19db74acfbbf86d3ea202e5f65f3cb73" args="(kim_selection_hints_t in_selection_hints)" --><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_selection_hints_forget_cached_results </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>in_selection_hints</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>
Remove an entry for the selection hints from the selection hints cache.
<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_selection_hints</em> </td><td>the selection hints to remove from the cache. </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="g8221dcbf6d972150252707a8d52ad5e5"></a><!-- doxytag: member="kim_selection_hints.h::kim_selection_hints_free" ref="g8221dcbf6d972150252707a8d52ad5e5" args="(kim_selection_hints_t *io_selection_hints)" --><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_selection_hints_free </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__kim__types__reference.html#g792f9e97aaf39dd7643221545ff475a3">kim_selection_hints_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>io_selection_hints</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 selection hints object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_selection_hints</em> </td><td>the selection hints 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 -->