group__kim__library__reference.html [plain text]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Kerberos Identity Management: KIM Library Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>KIM Library Documentation</h1>
<p>
<h2>Defines</h2>
<ul>
<li>#define <a class="el" href="group__kim__library__reference.html#gcd87f3f37afaec8574c8f7de57762638">KIM_UI_ENVIRONMENT_NONE</a> 0
<li>#define <a class="el" href="group__kim__library__reference.html#gb58175e1f93b385d9018247c3808f4ef">KIM_UI_ENVIRONMENT_AUTO</a> 1
<li>#define <a class="el" href="group__kim__library__reference.html#gcb8839fe96c7793c9047acbe20cc7504">KIM_UI_ENVIRONMENT_GUI</a> 2
<li>#define <a class="el" href="group__kim__library__reference.html#g1da8a35778f8ad3dc34ecaa569fe9092">KIM_UI_ENVIRONMENT_CLI</a> 3
</ul>
<h2>Typedefs</h2>
<ul>
<li>typedef int <a class="el" href="group__kim__library__reference.html#ged9db775d80a0de4a34287e972360146">kim_ui_environment</a>
</ul>
<h2>Functions</h2>
<ul>
<li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__library__reference.html#g88df8459520ff0406525caed6380efa2">kim_library_set_ui_environment</a> (<a class="el" href="group__kim__library__reference.html#ged9db775d80a0de4a34287e972360146">kim_ui_environment</a> in_ui_environment)
<dl class="el"><dd class="mdescRight">Tell KIM how to present UI from your application. <a href="#g88df8459520ff0406525caed6380efa2"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__library__reference.html#ge35892fc42ab06b342b43e8610e0c900">kim_library_set_allow_home_directory_access</a> (<a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> in_allow_access)
<dl class="el"><dd class="mdescRight">Tells KIM whether or not it is allowed to touch the user's home directory. <a href="#ge35892fc42ab06b342b43e8610e0c900"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__library__reference.html#g1daf766839e32fdc02c4c37978642951">kim_library_set_allow_automatic_prompting</a> (<a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> in_allow_automatic_prompting)
<dl class="el"><dd class="mdescRight">Tells KIM whether or not it is allowed to automatically present user interface. <a href="#g1daf766839e32fdc02c4c37978642951"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__library__reference.html#gfdf50a60bc513497e47852e43a02c8a9">kim_library_set_application_name</a> (<a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> in_application_name)
<dl class="el"><dd class="mdescRight">Set the name of your application for KIM to use for user interface. <a href="#gfdf50a60bc513497e47852e43a02c8a9"></a><br></dl></ul>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="gcd87f3f37afaec8574c8f7de57762638"></a><!-- doxytag: member="kim_library.h::KIM_UI_ENVIRONMENT_NONE" ref="gcd87f3f37afaec8574c8f7de57762638" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KIM_UI_ENVIRONMENT_NONE 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Do not present user interface
</div>
</div><p>
<a class="anchor" name="gb58175e1f93b385d9018247c3808f4ef"></a><!-- doxytag: member="kim_library.h::KIM_UI_ENVIRONMENT_AUTO" ref="gb58175e1f93b385d9018247c3808f4ef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KIM_UI_ENVIRONMENT_AUTO 1 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Automatically determine what user interface is appropriate (default).
</div>
</div><p>
<a class="anchor" name="gcb8839fe96c7793c9047acbe20cc7504"></a><!-- doxytag: member="kim_library.h::KIM_UI_ENVIRONMENT_GUI" ref="gcb8839fe96c7793c9047acbe20cc7504" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KIM_UI_ENVIRONMENT_GUI 2 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Present a graphical user interface
</div>
</div><p>
<a class="anchor" name="g1da8a35778f8ad3dc34ecaa569fe9092"></a><!-- doxytag: member="kim_library.h::KIM_UI_ENVIRONMENT_CLI" ref="g1da8a35778f8ad3dc34ecaa569fe9092" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KIM_UI_ENVIRONMENT_CLI 3 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Present a command line user interface
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="ged9db775d80a0de4a34287e972360146"></a><!-- doxytag: member="kim_library.h::kim_ui_environment" ref="ged9db775d80a0de4a34287e972360146" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="group__kim__library__reference.html#ged9db775d80a0de4a34287e972360146">kim_ui_environment</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An integer describing the type of user interface to use.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g88df8459520ff0406525caed6380efa2"></a><!-- doxytag: member="kim_library.h::kim_library_set_ui_environment" ref="g88df8459520ff0406525caed6380efa2" args="(kim_ui_environment in_ui_environment)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_library_set_ui_environment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__library__reference.html#ged9db775d80a0de4a34287e972360146">kim_ui_environment</a> </td>
<td class="paramname"> <em>in_ui_environment</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tell KIM how to present UI from your application.
<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_ui_environment</em> </td><td>an integer value describing the type of user interface to use. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Set to KIM_UI_ENVIRONMENT_AUTO by default. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge35892fc42ab06b342b43e8610e0c900"></a><!-- doxytag: member="kim_library.h::kim_library_set_allow_home_directory_access" ref="ge35892fc42ab06b342b43e8610e0c900" args="(kim_boolean in_allow_access)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_library_set_allow_home_directory_access </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> </td>
<td class="paramname"> <em>in_allow_access</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tells KIM whether or not it is allowed to touch the user's home directory.
<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_allow_access</em> </td><td>a boolean containing whether or not to touch the user's home directory. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This API is usually used for Kerberos authenticated home directories to prevent a deadlock. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g1daf766839e32fdc02c4c37978642951"></a><!-- doxytag: member="kim_library.h::kim_library_set_allow_automatic_prompting" ref="g1daf766839e32fdc02c4c37978642951" args="(kim_boolean in_allow_automatic_prompting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_library_set_allow_automatic_prompting </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#g6f8afd4047c4fe420c05f940f89ffba0">kim_boolean</a> </td>
<td class="paramname"> <em>in_allow_automatic_prompting</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tells KIM whether or not it is allowed to automatically present user interface.
<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_allow_automatic_prompting</em> </td><td>a boolean containing whether or not to prompt automatically. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gfdf50a60bc513497e47852e43a02c8a9"></a><!-- doxytag: member="kim_library.h::kim_library_set_application_name" ref="gfdf50a60bc513497e47852e43a02c8a9" args="(kim_string in_application_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_library_set_application_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> </td>
<td class="paramname"> <em>in_application_name</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the name of your application for KIM to use for user interface.
<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_application_name</em> </td><td>a string containing the localized name of your application. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>On many operating systems KIM can determine the caller's application name automatically. This call exists for applications to use when those mechanisms fail or do not exist. </dd></dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 3 17:45:44 2008 for Kerberos Identity Management by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>