add documention for krb5_kt_get_type

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@11787 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2003-03-16 18:33:27 +00:00
parent 342ad84447
commit 3d4847835f

View File

@@ -1,4 +1,4 @@
.\" Copyright (c) 2001 Kungliga Tekniska H<>gskolan .\" Copyright (c) 2001 - 2003 Kungliga Tekniska H<>gskolan
.\" (Royal Institute of Technology, Stockholm, Sweden). .\" (Royal Institute of Technology, Stockholm, Sweden).
.\" All rights reserved. .\" All rights reserved.
.\" .\"
@@ -48,6 +48,7 @@
.Nm krb5_kt_free_entry , .Nm krb5_kt_free_entry ,
.Nm krb5_kt_get_entry , .Nm krb5_kt_get_entry ,
.Nm krb5_kt_get_name , .Nm krb5_kt_get_name ,
.Nm krb5_kt_get_type ,
.Nm krb5_kt_next_entry , .Nm krb5_kt_next_entry ,
.Nm krb5_kt_read_service_key , .Nm krb5_kt_read_service_key ,
.Nm krb5_kt_register , .Nm krb5_kt_register ,
@@ -124,6 +125,13 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Fa "size_t namesize" .Fa "size_t namesize"
.Fc .Fc
.Ft krb5_error_code .Ft krb5_error_code
.Fo krb5_kt_get_type
.Fa "krb5_context context"
.Fa "krb5_keytab keytab"
.Fa "char *prefix"
.Fa "size_t prefixsize"
.Fc
.Ft krb5_error_code
.Fo krb5_kt_next_entry .Fo krb5_kt_next_entry
.Fa "krb5_context context" .Fa "krb5_context context"
.Fa "krb5_keytab id" .Fa "krb5_keytab id"
@@ -291,6 +299,18 @@ into
.Fa namesize . .Fa namesize .
Returns 0 or an error. Returns 0 or an error.
.Pp .Pp
.Fn krb5_kt_get_type
retrieves the type of the keytab
.Fa keytab
and store the prefix/name for type of the keytab into
.Fa prefix ,
.Fa prefixsize .
The prefix will have the maximum length of
.Dv KRB5_KT_PREFIX_MAX_LEN
(including terminating
.Dv NUL ) .
Returns 0 or an error.
.Pp
.Fn krb5_kt_free_entry .Fn krb5_kt_free_entry
frees the contents of frees the contents of
.Fa entry . .Fa entry .