crypto/heimdal/lib/krb5/krb5_eai_to_heim_errno.3

   1 .\" Copyright (c) 2004 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$
  33 .\"
  34 .Dd April 13, 2004
  35 .Dt KRB5_EAI_TO_HEIM_ERRNO 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_eai_to_heim_errno ,
  39 .Nm krb5_h_errno_to_heim_errno
  40 .Nd convert resolver error code to com_err error codes
  41 .Sh LIBRARY
  42 Kerberos 5 Library (libkrb5, -lkrb5)
  43 .Sh SYNOPSIS
  44 .In krb5.h
  45 .Ft krb5_error_code
  46 .Fo krb5_eai_to_heim_errno
  47 .Fa "int eai_errno"
  48 .Fa "int system_error"
  49 .Fc
  50 .Ft krb5_error_code
  51 .Fo krb5_h_errno_to_heim_errno
  52 .Fa "int eai_errno"
  53 .Fc
  54 .Sh DESCRIPTION
  55 .Fn krb5_eai_to_heim_errno
  56 and
  57 .Fn krb5_h_errno_to_heim_errno
  58 convert
  59 .Xr getaddrinfo 3 ,
  60 .Xr getnameinfo 3 ,
  61 and
  62 .Xr h_errno 3
  63 to com_err error code that are used by Heimdal, this is useful for for
  64 function returning kerberos errors and needs to communicate failures
  65 from resolver function.
  66 .Sh SEE ALSO
  67 .Xr krb5 3 ,
  68 .Xr kerberos 8