xref: /freebsd/crypto/heimdal/lib/krb5/krb5_init_context.3 (revision 41466b50c1d5bfd1cf6adaae547a579a75d7c04e)
1.\" Copyright (c) 2001 Kungliga Tekniska H�gskolan
2.\" $Id: krb5_init_context.3,v 1.2 2001/05/23 16:24:02 assar Exp $
3.Dd Jan 21, 2001
4.Dt KRB5_CONTEXT 3
5.Os HEIMDAL
6.Sh NAME
7.Nm krb5_init_context ,
8.Nm krb5_free_context
9.Sh SYNOPSIS
10.Fd #include <krb5.h>
11.Ft krb5_error_code
12.Fn krb5_init_context "krb5_context *context"
13.Ft void
14.Fn krb5_free_context "krb5_context context"
15.Sh DESCRIPTION
16The
17.Fn krb5_init_context
18function initializes the
19.Fa context
20structure and reads the configration file
21.Pa /etc/krb5.conf .
22.Pp
23The structure should be freed by calling
24.Fn krb5_free_context
25when it is no longer being used.
26.Sh RETURN VALUES
27.Fn krb5_init_context
28returns 0 to indicate success.
29Otherwise an errno code is returned.
30Failure means either that something bad happened during initialization
31(typically
32.Bq ENOMEM )
33or that Kerberos should not be used
34.Bq ENXIO .
35.Sh SEE ALSO
36.Xr krb5_context 3 ,
37.Xr errno 2 ,
38.Xr kerberos 8
39