Doxygen documentation.

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@22026 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2007-11-10 10:36:37 +00:00
parent 6553593f76
commit 8757ea7ba8

View File

@@ -108,6 +108,19 @@ krb5_have_error_string(krb5_context context)
return str != NULL;
}
/**
* Return the error message for `code' in context. On error the
* function returns NULL.
*
* @param context Kerberos 5 context
* @param code Error code related to the error
*
* @return an error string, needs to be freed with krb5_xfree(). The
* functions return NULL on error.
*
* @ingroup krb5_error
*/
char * KRB5_LIB_FUNCTION
krb5_get_error_message(krb5_context context, krb5_error_code code)
{