svn rev #24430: trunk/src/include/krb5/

[ghudson@MIT.EDU]

http://src.mit.edu/fisheye/changelog/krb5/?cs=24430
Commit By: ghudson
Log Message:
Document that krb5_get_error_message() never returns NULL.



Changed Files:
U   trunk/src/include/krb5/krb5.hin
Modified: trunk/src/include/krb5/krb5.hin
===================================================================
--- trunk/src/include/krb5/krb5.hin	2010-10-05 21:05:19 UTC (rev 24429)
+++ trunk/src/include/krb5/krb5.hin	2010-10-05 21:44:14 UTC (rev 24430)
@@ -2659,7 +2659,9 @@
  * 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.