Document that krb5_get_error_message() never returns NULL

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24430 dc483132-0cff-0310-8789-dd5450dbe970

diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index bd89f337219907548d46e2e69703c95773bd0b66..e04cf3b1123688a23f4bf18ad2280fbdfb855aed 100644 (file)
--- 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.