From d353b1f751041975decdaa2f7da7c3a5219b04d7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Love=20H=C3=B6rnquist=20=C3=85strand?= <lha@kth.se>
Date: Fri, 3 Feb 2006 12:40:25 +0000
Subject: [PATCH] Document krb5_get_error_message.

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@16694 ec53bebd-3082-4978-b11e-865c3cabbd6b
---
 lib/krb5/krb5_warn.3 | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/lib/krb5/krb5_warn.3 b/lib/krb5/krb5_warn.3
index 23be36af1..adca4db6e 100644
--- a/lib/krb5/krb5_warn.3
+++ b/lib/krb5/krb5_warn.3
@@ -43,6 +43,7 @@
 .Nm krb5_free_error_string
 .Nm krb5_get_err_text ,
 .Nm krb5_get_error_string ,
+.Nm krb5_get_error_message ,
 .Nm krb5_have_error_string ,
 .Nm krb5_set_error_string ,
 .Nm krb5_set_warn_dest ,
@@ -94,6 +95,8 @@ Kerberos 5 Library (libkrb5, -lkrb5)
 .Fn krb5_get_err_text "krb5_context context" "krb5_error_code code"
 .Ft char*
 .Fn krb5_get_error_string "krb5_context context"
+.Ft char*
+.Fn krb5_get_error_message "krb5_context context, krb5_error_code code"
 .Ft krb5_boolean
 .Fn krb5_have_error_string "krb5_context context"
 .Ft krb5_error_code
@@ -162,12 +165,27 @@ fetches the error string from
 The error message in the context is consumed and must be freed using
 .Fn krb5_free_error_string
 by the caller.
+See also
+.Fn krb5_get_error_message ,
+what is usually less verbose to use.
 .Pp
 .Fn krb5_have_error_string
 returns
 .Dv TRUE
 if there is a verbose error message in the
 .Fa context .
+.Pp
+.Fn krb5_get_error_message
+fetches the error string from the context, or if there
+is no customized error string in
+.Fa context ,
+uses
+.Fa code
+to return a error string.
+In either case, the error message in the context is consumed and must
+be freed using
+.Fn krb5_free_error_string
+by the caller.
 .Sh SEE ALSO
 .Xr krb5 3 ,
 .Xr krb5_openlog 3