lib/krb5/krb5_getportbyname.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 August 15, 2004
  35 .Dt NAME 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_getportbyname
  39 .Nd get port number by name
  40 .Sh LIBRARY
  41 Kerberos 5 Library (libkrb5, -lkrb5)
  42 .Sh SYNOPSIS
  43 .In krb5.h
  44 .Ft int
  45 .Fo krb5_getportbyname
  46 .Fa "krb5_context context"
  47 .Fa "const char *service"
  48 .Fa "const char *proto"
  49 .Fa "int default_port"
  50 .Fc
  51 .Sh DESCRIPTION
  52 .Fn krb5_getportbyname
  53 gets the port number for
  54 .Fa service /
  55 .Fa proto
  56 pair from the global service table for and returns it in network order.
  57 If it isn't found in the global table, the
  58 .Fa default_port
  59 (given in host order)
  60 is returned.
  61 .Sh EXAMPLE
  62 .Bd -literal
  63 int port = krb5_getportbyname(context, "kerberos", "tcp", 88);
  64 .Ed
  65 .\" .Sh BUGS
  66 .Sh SEE ALSO
  67 .Xr krb5 3