From 4e9c85d51c18935b0aa401ddd4e4c873eaaff0e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Love=20H=C3=B6rnquist=20=C3=85strand?= Date: Tue, 9 Aug 2005 16:29:31 +0000 Subject: [PATCH] Document krb5_verify_opt_alloc and krb5_verify_opt_free. git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@15856 ec53bebd-3082-4978-b11e-865c3cabbd6b --- lib/krb5/krb5_verify_user.3 | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/lib/krb5/krb5_verify_user.3 b/lib/krb5/krb5_verify_user.3 index abb5e3a3b..c70643a0d 100644 --- a/lib/krb5/krb5_verify_user.3 +++ b/lib/krb5/krb5_verify_user.3 @@ -38,7 +38,9 @@ .Nm krb5_verify_user , .Nm krb5_verify_user_lrealm , .Nm krb5_verify_user_opt , -.Nm krb5_verify_opt_init +.Nm krb5_verify_opt_init , +.Nm krb5_verify_opt_alloc , +.Nm krb5_verify_opt_free , .Nm krb5_verify_opt_set_ccache , .Nm krb5_verify_opt_set_flags , .Nm krb5_verify_opt_set_service , @@ -56,6 +58,10 @@ Kerberos 5 Library (libkrb5, -lkrb5) .Ft void .Fn krb5_verify_opt_init "krb5_verify_opt *opt" .Ft void +.Fn krb5_verify_opt_alloc "krb5_verify_opt **opt" +.Ft void +.Fn krb5_verify_opt_free "krb5_verify_opt *opt" +.Ft void .Fn krb5_verify_opt_set_ccache "krb5_verify_opt *opt" "krb5_ccache ccache" .Ft void .Fn krb5_verify_opt_set_keytab "krb5_verify_opt *opt" "krb5_keytab keytab" @@ -110,7 +116,7 @@ if given as ). .Pp The -.Nm krb5_verify_user_lrealm +.Fn krb5_verify_user_lrealm function does the same, except that it ignores the realm in .Fa principal and tries all the local realms (see @@ -120,6 +126,15 @@ realm. If the call fails, the principal will not be meaningful, and should only be freed with .Xr krb5_free_principal 3 . .Pp +.Fn krb5_verify_opt_alloc +and +.Fn krb5_verify_opt_free +allocates and frees a +.Li krb5_verify_opt . +You should use the the alloc and free function instead of allocation +the structure yourself, this is because in a future release the +structure wont be exported. +.Pp .Fn krb5_verify_opt_init resets all opt to default values. .Pp