summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorGreg Hudson <ghudson@mit.edu>2010-10-05 21:44:14 +0000
committerGreg Hudson <ghudson@mit.edu>2010-10-05 21:44:14 +0000
commit9f7a997952a9fba05a83175295c9d1be938b68b8 (patch)
treeb94ff0e8fb9539b2ee59d2baec9b406fc2d80203 /src
parent26ff86b99636dfd136d93b5cc7e50623be4d70fa (diff)
downloadkrb5-9f7a997952a9fba05a83175295c9d1be938b68b8.tar.gz
krb5-9f7a997952a9fba05a83175295c9d1be938b68b8.tar.xz
krb5-9f7a997952a9fba05a83175295c9d1be938b68b8.zip
Document that krb5_get_error_message() never returns NULL
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24430 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'src')
-rw-r--r--src/include/krb5/krb5.hin4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index bd89f33721..e04cf3b112 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -2659,7 +2659,9 @@ krb5_copy_error_message(krb5_context, krb5_context);
* time it is called after a failed call to a krb5 function using the
* same context, and only when the error code passed in is the same as
* that returned by the krb5 function. Future versions may return the
- * same string for the second and following calls.
+ * same string for the second and following calls. This function never
+ * returns NULL, so its result may be used unconditionally as a C
+ * string.
*
* The string returned by this function must be freed using
* krb5_free_error_message.