Edit File: group__kim__string__reference.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Kerberos Identity Management: KIM String Reference 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 String Reference Documentation</h1> <p> <h2>Functions</h2> <ul> <li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__string__reference.html#gf1f7a5aba5f87b139f1b1db1430ca94b">kim_string_create_for_last_error</a> (<a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> *out_string, <a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> in_error) <dl class="el"><dd class="mdescRight">Get a text description of an error suitable for display to the user. <a href="#gf1f7a5aba5f87b139f1b1db1430ca94b"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__string__reference.html#g75780c8ab031eaab2b588014c7078b58">kim_string_copy</a> (<a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> *out_string, const <a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> in_string) <dl class="el"><dd class="mdescRight">Copy a string. <a href="#g75780c8ab031eaab2b588014c7078b58"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__string__reference.html#g504d17196463065016bfc11ef8ff44bb">kim_string_compare</a> (<a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> in_string, <a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> in_compare_to_string, <a class="el" href="group__kim__types__reference.html#gae48569e847ff6af9d10add42a4338e7">kim_comparison</a> *out_comparison) <dl class="el"><dd class="mdescRight">Compare two strings. <a href="#g504d17196463065016bfc11ef8ff44bb"></a><br></dl><li>void <a class="el" href="group__kim__string__reference.html#g7e7207329022e97473ec71574e52a1fc">kim_string_free</a> (<a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> *io_string) <dl class="el"><dd class="mdescRight">Free memory associated with a string. <a href="#g7e7207329022e97473ec71574e52a1fc"></a><br></dl></ul> <hr><h2>Function Documentation</h2> <a class="anchor" name="gf1f7a5aba5f87b139f1b1db1430ca94b"></a><!-- doxytag: member="kim_string.h::kim_string_create_for_last_error" ref="gf1f7a5aba5f87b139f1b1db1430ca94b" args="(kim_string *out_string, kim_error in_error)" --> <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_string_create_for_last_error </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> * </td> <td class="paramname"> <em>out_string</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> </td> <td class="paramname"> <em>in_error</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Get a text description of an error suitable for display to the user. <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_string</em> </td><td>On success, a human-readable UTF-8 string describing the error representedby <em>in_error</em>. Must be freed with <a class="el" href="group__kim__string__reference.html#g7e7207329022e97473ec71574e52a1fc" title="Free memory associated with a string.">kim_string_free()</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>in_error</em> </td><td>an error code. Used to verify that the correct error string will be returned (see note below). </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, KIM_NO_ERROR. </dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd>This API is implemented using thread local storage. It should be called immediately after a KIM API returns an error code so that the correct string is returned. The returned copy may then be held by the caller until needed. If <em>in_error</em> does not match the last saved error KIM may return a less descriptive string. </dd></dl> </div> </div><p> <a class="anchor" name="g75780c8ab031eaab2b588014c7078b58"></a><!-- doxytag: member="kim_string.h::kim_string_copy" ref="g75780c8ab031eaab2b588014c7078b58" args="(kim_string *out_string, const kim_string in_string)" --> <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_string_copy </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> * </td> <td class="paramname"> <em>out_string</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> </td> <td class="paramname"> <em>in_string</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Copy a string. <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_string</em> </td><td>on exit, a new string object which is a copy of <em>in_string</em>. Must be freed with <a class="el" href="group__kim__string__reference.html#g7e7207329022e97473ec71574e52a1fc" title="Free memory associated with a string.">kim_string_free()</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>in_string</em> </td><td>the string to copy. </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="g504d17196463065016bfc11ef8ff44bb"></a><!-- doxytag: member="kim_string.h::kim_string_compare" ref="g504d17196463065016bfc11ef8ff44bb" args="(kim_string in_string, kim_string in_compare_to_string, kim_comparison *out_comparison)" --> <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_string_compare </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_string</em>, </td> </tr> <tr> <td class="paramkey"></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_compare_to_string</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#gae48569e847ff6af9d10add42a4338e7">kim_comparison</a> * </td> <td class="paramname"> <em>out_comparison</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Compare two strings. <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_string</em> </td><td>a string. </td></tr> <tr><td valign="top"></td><td valign="top"><em>in_compare_to_string</em> </td><td>a string to be compared to <em>in_string</em>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>out_comparison</em> </td><td>on exit, a comparison result indicating whether <em>in_string</em> is greater than, less than or equal to <em>in_compare_to_string</em>. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl> </div> </div><p> <a class="anchor" name="g7e7207329022e97473ec71574e52a1fc"></a><!-- doxytag: member="kim_string.h::kim_string_free" ref="g7e7207329022e97473ec71574e52a1fc" args="(kim_string *io_string)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void kim_string_free </td> <td>(</td> <td class="paramtype"><a class="el" href="group__kim__types__reference.html#geea99aa292876e06003b7480087eecb0">kim_string</a> * </td> <td class="paramname"> <em>io_string</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Free memory associated with a string. <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_string</em> </td><td>a string to be freed. Set to NULL on exit. </td></tr> </table> </dl> </div> </div><p> <hr size="1"><address style="text-align: right;"><small>Generated on 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>
Back to File Manager