diff options
| author | Alexandra Ellwood <lxs@mit.edu> | 2008-10-01 22:43:19 +0000 |
|---|---|---|
| committer | Alexandra Ellwood <lxs@mit.edu> | 2008-10-01 22:43:19 +0000 |
| commit | 3616d31222f94d3f8f3ee23a094dce20ddab719d (patch) | |
| tree | af539f606157043bac9518a9cb0dbd26189c1c19 /doc/kim/html/kim_string_overview.html | |
| parent | 541f8d94504bb2e5592df26a0194e56ed17b13da (diff) | |
| download | krb5-3616d31222f94d3f8f3ee23a094dce20ddab719d.tar.gz krb5-3616d31222f94d3f8f3ee23a094dce20ddab719d.tar.xz krb5-3616d31222f94d3f8f3ee23a094dce20ddab719d.zip | |
Updated documentation to reflect new APIs and re-ran Doxygen
ticket: 6055
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@20806 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'doc/kim/html/kim_string_overview.html')
| -rw-r--r-- | doc/kim/html/kim_string_overview.html | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/kim/html/kim_string_overview.html b/doc/kim/html/kim_string_overview.html index f9e9422f9..ced9da69d 100644 --- a/doc/kim/html/kim_string_overview.html +++ b/doc/kim/html/kim_string_overview.html @@ -6,8 +6,12 @@ </head><body> <!-- Generated by Doxygen 1.5.3 --> <h1><a class="anchor" name="kim_string_overview">KIM String Overview</a></h1>A UTF8 string.<p> -Memory management routines are provided for runtime consistency on operating systems with shared libraries and multiple runtimes.<p> -See <a class="el" href="group__kim__string__reference.html">KIM String Reference Documentation</a> for information on specific APIs. <hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 22 18:09:05 2008 for Kerberos Identity Management by +Memory management routines are provided for runtime consistency on operating systems with shared libraries and multiple runtimes.<h2><a class="anchor" name="kim_string_error_messages"> +KIM Error Messages</a></h2> +Like most C APIs, the KIM API returns numeric error codes. These error codes may come from KIM, krb5 or GSS APIs. In most cases the caller will want to handle these error programmatically. However, in some circumstances the caller may wish to print an error string to the user.<p> +One problem with just printing the error code to the user is that frequently the context behind the error has been lost. For example if KIM is trying to obtain credentials via referrals, it may fail partway through the process. In this case the error code will be KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN, which maps to "Client not found in Kerberos database". Unfortunately this error isn't terribly helpful because it doesn't tell the user whether they typoed their principal name or if referrals failed.<p> +To avoid this problem, KIM maintains an explanatory string for the last error seen in each thread calling into KIM. If a caller wishes to display an error to the user, immediately after getting the error the caller should call <a class="el" href="group__kim__string__reference.html#gf1f7a5aba5f87b139f1b1db1430ca94b" title="Get a text description of an error suitable for display to the user.">kim_string_create_for_last_error()</a> to obtain a copy of the descriptive error message.<p> +See <a class="el" href="group__kim__string__reference.html">KIM String Reference Documentation</a> for information on specific APIs. <hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 1 18:42:06 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> |