mirror of
https://github.com/freebsd/freebsd-src
synced 2024-10-24 01:03:19 +00:00
42 lines
1 KiB
Groff
42 lines
1 KiB
Groff
.\" Copyright (c) 2001 Kungliga Tekniska Högskolan
|
|
.\" $Id: krb5_init_context.3,v 1.6 2002/09/02 12:42:00 joda Exp $
|
|
.Dd January 21, 2001
|
|
.Dt KRB5_CONTEXT 3
|
|
.Os HEIMDAL
|
|
.Sh NAME
|
|
.Nm krb5_init_context ,
|
|
.Nm krb5_free_context
|
|
.Nd create and delete krb5_context structures
|
|
.Sh LIBRARY
|
|
Kerberos 5 Library (libkrb5, -lkrb5)
|
|
.Sh SYNOPSIS
|
|
.Fd #include <krb5.h>
|
|
.Ft krb5_error_code
|
|
.Fn krb5_init_context "krb5_context *context"
|
|
.Ft void
|
|
.Fn krb5_free_context "krb5_context context"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn krb5_init_context
|
|
function initializes the
|
|
.Fa context
|
|
structure and reads the configuration file
|
|
.Pa /etc/krb5.conf .
|
|
.Pp
|
|
The structure should be freed by calling
|
|
.Fn krb5_free_context
|
|
when it is no longer being used.
|
|
.Sh RETURN VALUES
|
|
.Fn krb5_init_context
|
|
returns 0 to indicate success.
|
|
Otherwise an errno code is returned.
|
|
Failure means either that something bad happened during initialization
|
|
(typically
|
|
.Bq ENOMEM )
|
|
or that Kerberos should not be used
|
|
.Bq ENXIO .
|
|
.Sh SEE ALSO
|
|
.Xr errno 2 ,
|
|
.Xr krb5_context 3 ,
|
|
.Xr kerberos 8
|