oysteikt/heimdal
0
0
Fork 0
Code Issues 5 Pull Requests Releases Activity

Document krb5_get_error_message.

Browse Source 
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@16694 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2006-02-03 12:40:25 +00:00
parent 7b20682f7b
commit d353b1f751
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
lib/krb5/krb5_warn.3
View File

@@ -43,6 +43,7 @@
.Nm krb5_free_error_string .Nm krb5_free_error_string
.Nm krb5_get_err_text , .Nm krb5_get_err_text ,
.Nm krb5_get_error_string , .Nm krb5_get_error_string ,
.Nm krb5_get_error_message ,
.Nm krb5_have_error_string , .Nm krb5_have_error_string ,
.Nm krb5_set_error_string , .Nm krb5_set_error_string ,
.Nm krb5_set_warn_dest , .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" .Fn krb5_get_err_text "krb5_context context" "krb5_error_code code"
.Ft char* .Ft char*
.Fn krb5_get_error_string "krb5_context context" .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 .Ft krb5_boolean
.Fn krb5_have_error_string "krb5_context context" .Fn krb5_have_error_string "krb5_context context"
.Ft krb5_error_code .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 The error message in the context is consumed and must be freed using
.Fn krb5_free_error_string .Fn krb5_free_error_string
by the caller. by the caller.
See also
.Fn krb5_get_error_message ,
what is usually less verbose to use.
.Pp .Pp
.Fn krb5_have_error_string .Fn krb5_have_error_string
returns returns
.Dv TRUE .Dv TRUE
if there is a verbose error message in the if there is a verbose error message in the
.Fa context . .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 .Sh SEE ALSO
.Xr krb5 3 , .Xr krb5 3 ,
.Xr krb5_openlog 3 .Xr krb5_openlog 3