description for krb5_passwd_result_to_string


git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@14050 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2004-07-15 14:37:28 +00:00
parent 3bd52a0551
commit 9991bfc29b

View File

@@ -31,13 +31,14 @@
.\"
.\" $Id$
.\"
.Dd June 2, 2004
.Dd July 15, 2004
.Dt KRB5_SET_PASSWORD 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_change_password ,
.Nm krb5_set_password ,
.Nm krb5_set_password_using_ccache
.Nm krb5_set_password_using_ccache ,
.Nm krb5_passwd_result_to_string
.Nd change password functions
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
@@ -72,6 +73,11 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Fa "krb5_data *result_code_string"
.Fa "krb5_data *result_string"
.Fc
.Ft "const char *"
.Fo krb5_passwd_result_to_string
.Fa "krb5_context context"
.Fa "int result"
.Fc
.Sh DESCRIPTION
These functions change the password for a given principal.
.Pp
@@ -93,7 +99,7 @@ The server principal of creds must be
.Fn krb5_set_password
and
.Fn krb5_set_password_using_ccache
changes the password for the principal
change the password for the principal
.Fa targprinc .
.Pp
.Fn krb5_set_password
@@ -121,10 +127,17 @@ and
.Fn krb5_set_password
uses the global the default principal.
.Pp
All three functions returns and error in
All three functions return an error in
.Fa result_code
and maybe an error string to print in
.Fa result_string .
.Pp
.Fn krb5_passwd_result_to_string
returns an human readable string describing the error code in
.Fa result_code
from the
.Fn krb5_set_password
functions.
.Sh SEE ALSO
.Xr krb5_ccache 3 ,
.Xr krb5_init_context 3