xref: /freebsd/crypto/heimdal/lib/krb5/krb5_init_context.3 (revision 4137ff4cc173ea2e05227027e1c9e0ea42bcc0dc)
1.\" Copyright (c) 2001 Kungliga Tekniska H�gskolan
2.\" $Id: krb5_init_context.3,v 1.4 2001/07/12 08:42:28 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.Nd create and delete krb5_context structures
10.Sh SYNOPSIS
11.Fd #include <krb5.h>
12.Ft krb5_error_code
13.Fn krb5_init_context "krb5_context *context"
14.Ft void
15.Fn krb5_free_context "krb5_context context"
16.Sh DESCRIPTION
17The
18.Fn krb5_init_context
19function initializes the
20.Fa context
21structure and reads the configration file
22.Pa /etc/krb5.conf .
23.Pp
24The structure should be freed by calling
25.Fn krb5_free_context
26when it is no longer being used.
27.Sh RETURN VALUES
28.Fn krb5_init_context
29returns 0 to indicate success.
30Otherwise an errno code is returned.
31Failure means either that something bad happened during initialization
32(typically
33.Bq ENOMEM )
34or that Kerberos should not be used
35.Bq ENXIO .
36.Sh SEE ALSO
37.Xr errno 2 ,
38.Xr krb5_context 3 ,
39.Xr kerberos 8
40