crypto/heimdal/lib/krb5/krb5_init_context.3

   1 .\" Copyright (c) 2001 - 2002 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $Id: krb5_init_context.3,v 1.9 2003/04/16 13:58:11 lha Exp $
  33 .\"
  34 .Dd January 21, 2001
  35 .Dt KRB5_CONTEXT 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_init_context ,
  39 .Nm krb5_free_context
  40 .Nd create and delete krb5_context structures
  41 .Sh LIBRARY
  42 Kerberos 5 Library (libkrb5, -lkrb5)
  43 .Sh SYNOPSIS
  44 .In krb5.h
  45 .Ft krb5_error_code
  46 .Fn krb5_init_context "krb5_context *context"
  47 .Ft void
  48 .Fn krb5_free_context "krb5_context context"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn krb5_init_context
  52 function initializes the
  53 .Fa context
  54 structure and reads the configuration file
  55 .Pa /etc/krb5.conf .
  56 .Pp
  57 The structure should be freed by calling
  58 .Fn krb5_free_context
  59 when it is no longer being used.
  60 .Sh RETURN VALUES
  61 .Fn krb5_init_context
  62 returns 0 to indicate success.
  63 Otherwise an errno code is returned.
  64 Failure means either that something bad happened during initialization
  65 (typically
  66 .Bq ENOMEM )
  67 or that Kerberos should not be used
  68 .Bq ENXIO .
  69 .Sh SEE ALSO
  70 .Xr errno 2 ,
  71 .Xr krb5_context 3 ,
  72 .Xr kerberos 8