external/bsd/libbind/dist/doc/getipnodebyname.cat3

   1 GETIPNODEBYNAME(3)       BSD Library Functions Manual       GETIPNODEBYNAME(3)
   2
   3 N\bNA\bAM\bME\bE
   4      g\bge\bet\bti\bip\bpn\bno\bod\bde\beb\bby\byn\bna\bam\bme\be, g\bge\bet\bti\bip\bpn\bno\bod\bde\beb\bby\bya\bad\bdd\bdr\br - get network host entry
   5      f\bfr\bre\bee\beh\bho\bos\bst\bte\ben\bnt\bt - free network host entry
   6
   7 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
   8      #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<n\bne\bet\btd\bdb\bb.\b.h\bh>\b>
   9
  10      _\bs_\bt_\br_\bu_\bc_\bt _\bh_\bo_\bs_\bt_\be_\bn_\bt _\b*
  11      g\bge\bet\bti\bip\bpn\bno\bod\bde\beb\bby\byn\bna\bam\bme\be(_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bn_\ba_\bm_\be, _\bi_\bn_\bt _\ba_\bf, _\bi_\bn_\bt _\bf_\bl_\ba_\bg_\bs, _\bi_\bn_\bt _\b*_\be_\br_\br_\bo_\br);
  12
  13      _\bs_\bt_\br_\bu_\bc_\bt _\bh_\bo_\bs_\bt_\be_\bn_\bt _\b*
  14      g\bge\bet\bti\bip\bpn\bno\bod\bde\beb\bby\bya\bad\bdd\bdr\br(_\bc_\bo_\bn_\bs_\bt _\bv_\bo_\bi_\bd _\b*_\ba_\bd_\bd_\br, _\bs_\bi_\bz_\be_\b__\bt _\bl_\be_\bn, _\bi_\bn_\bt _\ba_\bf, _\bi_\bn_\bt _\b*_\be_\br_\br_\bo_\br);
  15
  16      _\bv_\bo_\bi_\bd
  17      f\bfr\bre\bee\beh\bho\bos\bst\bte\ben\bnt\bt(_\bs_\bt_\br_\bu_\bc_\bt _\bh_\bo_\bs_\bt_\be_\bn_\bt _\b*_\bh_\be);
  18
  19 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  20      G\bGe\bet\bti\bip\bpn\bno\bod\bde\beb\bby\byn\bna\bam\bme\be(), and g\bge\bet\bti\bip\bpn\bno\bod\bde\beb\bby\bya\bad\bdd\bdr\br() each return a pointer to a
  21      _\bh_\bo_\bs_\bt_\be_\bn_\bt structure (see below) describing an internet host referenced by
  22      name or by address, as the function names indicate.  This structure con‐
  23      tains either the information obtained from the name server, or broken-out
  24      fields from a line in _\b/_\be_\bt_\bc_\b/_\bh_\bo_\bs_\bt_\bs.  If the local name server is not run‐
  25      ning, these routines do a lookup in _\b/_\be_\bt_\bc_\b/_\bh_\bo_\bs_\bt_\bs.
  26
  27            struct  hostent {
  28                    char    *h_name;        /* official name of host */
  29                    char    **h_aliases;    /* alias list */
  30                    int     h_addrtype;     /* host address type */
  31                    int     h_length;       /* length of address */
  32                    char    **h_addr_list;  /* list of addresses from name server */
  33            };
  34
  35            #define h_addr  h_addr_list[0]  /* address, for backward compatibility */
  36
  37      The members of this structure are:
  38
  39      h_name       Official name of the host.
  40
  41      h_aliases    A zero-terminated array of alternate names for the host.
  42
  43      h_addrtype   The type of address being returned.
  44
  45      h_length     The length, in bytes, of the address.
  46
  47      h_addr_list  A zero-terminated array of network addresses for the host.
  48                   Host addresses are returned in network byte order.
  49
  50      h_addr       The first address in h_addr_list; this is for backward com‐
  51                   patibility.
  52
  53      This structure should be freed after use by calling f\bfr\bre\bee\beh\bho\bos\bst\bte\ben\bnt\bt().
  54
  55      When using the nameserver, g\bge\bet\bti\bip\bph\bho\bos\bst\btb\bby\bya\bad\bdd\bdr\br() will search for the named
  56      host in each parent domain given in the “search” directive of
  57      resolv.conf(5) unless the name contains a dot (“.”).  If the name con‐
  58      tains no dot, and if the environment variable HOSTALIASES contains the
  59      name of an alias file, the alias file will first be searched for an alias
  60      matching the input name.  See hostname(7) for the domain search procedure
  61      and the alias file format.
  62
  63      G\bGe\bet\bti\bip\bph\bho\bos\bst\btb\bby\bya\bad\bdd\bdr\br() can be told to look for IPv4 addresses, IPv6 addresses
  64      or both IPv4 and IPv6.  If IPv4 addresses only are to be looked up then
  65      _\ba_\bf should be set to AF_INET, otherwise it should be set to AF_INET6.
  66
  67      There are three flags that can be set
  68
  69      AI_V4MAPPED    Return IPv4 addresses if no IPv6 addresses are found.
  70                     This flag is ignored unless _\ba_\bf is AF_INET6.
  71
  72      AI_ALL         Return IPv4 addresses as well IPv6 addresses if
  73                     AI_V4MAPPED is set.  This flag is ignored unless _\ba_\bf is
  74                     AF_INET6.
  75
  76      AI_ADDRCONFIG  Only return addresses of a given type if the system has an
  77                     active interface with that type.
  78
  79      Also AI_DEFAULT is defined to be (AI_V4MAPPED|AI_ADDRCONFIG).
  80
  81      G\bGe\bet\bti\bip\bpn\bno\bod\bde\beb\bby\bya\bad\bdd\bdr\br() will lookup IPv4 mapped and compatible addresses in the
  82      IPv4 name space and IPv6 name space
  83
  84      F\bFr\bre\bee\beh\bho\bos\bst\bte\ben\bnt\bt() frees the hostent structure allocated be g\bge\bet\bti\bip\bpn\bno\bod\bde\beb\bby\byn\bna\bam\bme\be()
  85      and g\bge\bet\bti\bip\bpn\bno\bod\bde\beb\bby\bya\bad\bdd\bdr\br().  The structures returned by g\bge\bet\bth\bho\bos\bst\btb\bby\byn\bna\bam\bme\be(),
  86      g\bge\bet\bth\bho\bos\bst\btb\bby\byn\bna\bam\bme\be2\b2(), g\bge\bet\bth\bho\bos\bst\btb\bby\bya\bad\bdd\bdr\br() and g\bge\bet\bth\bho\bos\bst\bte\ben\bnt\bt() should not be passed
  87      to f\bfr\bre\bee\beh\bho\bos\bst\bte\ben\bnt\bt() as they are pointers to static areas.
  88
  89 E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
  90      HOSTALIASES    Name of file containing (_\bh_\bo_\bs_\bt _\ba_\bl_\bi_\ba_\bs, _\bf_\bu_\bl_\bl _\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be) pairs.
  91
  92 F\bFI\bIL\bLE\bES\bS
  93      /etc/hosts     See hosts(5).
  94
  95 D\bDI\bIA\bAG\bGN\bNO\bOS\bST\bTI\bIC\bCS\bS
  96      Error return status from g\bge\bet\bti\bip\bpn\bno\bod\bde\beb\bby\byn\bna\bam\bme\be() and g\bge\bet\bti\bip\bpn\bno\bod\bde\beb\bby\bya\bad\bdd\bdr\br() is indi‐
  97      cated by return of a null pointer.  In this case _\be_\br_\br_\bo_\br may then be
  98      checked to see whether this is a temporary failure or an invalid or
  99      unknown host.  _\be_\br_\br_\bn_\bo can have the following values:
 100
 101            NETDB_INTERNAL    This indicates an internal error in the library,
 102                              unrelated to the network or name service.  _\be_\br_\br_\bn_\bo
 103                              will be valid in this case; see perror.
 104
 105            HOST_NOT_FOUND    No such host is known.
 106
 107            TRY_AGAIN         This is usually a temporary error and means that
 108                              the local server did not receive a response from
 109                              an authoritative server.  A retry at some later
 110                              time may succeed.
 111
 112            NO_RECOVERY       Some unexpected server failure was encountered.
 113                              This is a non-recoverable error, as one might
 114                              expect.
 115
 116            NO_ADDRESS        The requested name is valid but does not have an
 117                              IP address; this is not a temporary error.  This
 118                              means that the name is known to the name server
 119                              but there is no address associated with this
 120                              name.  Another type of request to the name server
 121                              using this domain name will result in an answer;
 122                              for example, a mail-forwarder may be registered
 123                              for this domain.
 124
 125 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
 126      hosts(5), hostname(7), resolver(3), resolver(5), gethostbyname(3),
 127      RFC2553.
 128
 129 4th Berkeley Distribution     September 17, 1999     4th Berkeley Distribution