contrib/bind-9.2.4rc7/lib/lwres/man/lwres_inetntop.html

   1 <!--
   2  - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2001  Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17
  18 <!-- $Id: lwres_inetntop.html,v 1.5.2.2 2004/03/15 04:45:04 marka Exp $ -->
  19
  20 <HTML
  21 ><HEAD
  22 ><TITLE
  23 >lwres_inetntop</TITLE
  24 ><META
  25 NAME="GENERATOR"
  26 CONTENT="Modular DocBook HTML Stylesheet Version 1.73
  27 "></HEAD
  28 ><BODY
  29 CLASS="REFENTRY"
  30 BGCOLOR="#FFFFFF"
  31 TEXT="#000000"
  32 LINK="#0000FF"
  33 VLINK="#840084"
  34 ALINK="#0000FF"
  35 ><H1
  36 ><A
  37 NAME="AEN1"
  38 >lwres_inetntop</A
  39 ></H1
  40 ><DIV
  41 CLASS="REFNAMEDIV"
  42 ><A
  43 NAME="AEN8"
  44 ></A
  45 ><H2
  46 >Name</H2
  47 >lwres_net_ntop&nbsp;--&nbsp;lightweight resolver IP address presentation</DIV
  48 ><DIV
  49 CLASS="REFSYNOPSISDIV"
  50 ><A
  51 NAME="AEN11"
  52 ></A
  53 ><H2
  54 >Synopsis</H2
  55 ><DIV
  56 CLASS="FUNCSYNOPSIS"
  57 ><A
  58 NAME="AEN12"
  59 ></A
  60 ><P
  61 ></P
  62 ><PRE
  63 CLASS="FUNCSYNOPSISINFO"
  64 >#include &lt;lwres/net.h&gt;</PRE
  65 ><P
  66 ><CODE
  67 ><CODE
  68 CLASS="FUNCDEF"
  69 >const char *
  70 lwres_net_ntop</CODE
  71 >(int af, const void *src, char *dst, size_t size);</CODE
  72 ></P
  73 ><P
  74 ></P
  75 ></DIV
  76 ></DIV
  77 ><DIV
  78 CLASS="REFSECT1"
  79 ><A
  80 NAME="AEN21"
  81 ></A
  82 ><H2
  83 >DESCRIPTION</H2
  84 ><P
  85 ><TT
  86 CLASS="FUNCTION"
  87 >lwres_net_ntop()</TT
  88 > converts an IP address of
  89 protocol family <TT
  90 CLASS="PARAMETER"
  91 ><I
  92 >af</I
  93 ></TT
  94 > &mdash; IPv4 or IPv6 &mdash;
  95 at location <TT
  96 CLASS="PARAMETER"
  97 ><I
  98 >src</I
  99 ></TT
 100 > from network format to its
 101 conventional representation as a string.  For IPv4 addresses, that
 102 string would be a dotted-decimal.  An IPv6 address would be
 103 represented in colon notation as described in RFC1884.</P
 104 ><P
 105 >The generated string is copied to <TT
 106 CLASS="PARAMETER"
 107 ><I
 108 >dst</I
 109 ></TT
 110 > provided
 111 <TT
 112 CLASS="PARAMETER"
 113 ><I
 114 >size</I
 115 ></TT
 116 > indicates it is long enough to store the
 117 ASCII representation of the address.</P
 118 ></DIV
 119 ><DIV
 120 CLASS="REFSECT1"
 121 ><A
 122 NAME="AEN30"
 123 ></A
 124 ><H2
 125 >RETURN VALUES</H2
 126 ><P
 127 >If successful, the function returns <TT
 128 CLASS="PARAMETER"
 129 ><I
 130 >dst</I
 131 ></TT
 132 >:
 133 a pointer to a string containing the presentation format of the
 134 address.  <TT
 135 CLASS="FUNCTION"
 136 >lwres_net_ntop()</TT
 137 > returns
 138 <SPAN
 139 CLASS="TYPE"
 140 >NULL</SPAN
 141 > and sets the global variable
 142 <TT
 143 CLASS="CONSTANT"
 144 >errno</TT
 145 > to <SPAN
 146 CLASS="ERRORCODE"
 147 >EAFNOSUPPORT</SPAN
 148 > if
 149 the protocol family given in <TT
 150 CLASS="PARAMETER"
 151 ><I
 152 >af</I
 153 ></TT
 154 > is not
 155 supported.</P
 156 ></DIV
 157 ><DIV
 158 CLASS="REFSECT1"
 159 ><A
 160 NAME="AEN39"
 161 ></A
 162 ><H2
 163 >SEE ALSO</H2
 164 ><P
 165 ><SPAN
 166 CLASS="CITEREFENTRY"
 167 ><SPAN
 168 CLASS="REFENTRYTITLE"
 169 >RFC1884</SPAN
 170 ></SPAN
 171 >,
 172 <SPAN
 173 CLASS="CITEREFENTRY"
 174 ><SPAN
 175 CLASS="REFENTRYTITLE"
 176 >inet_ntop</SPAN
 177 >(3)</SPAN
 178 >,
 179 <SPAN
 180 CLASS="CITEREFENTRY"
 181 ><SPAN
 182 CLASS="REFENTRYTITLE"
 183 >errno</SPAN
 184 >(3)</SPAN
 185 >.</P
 186 ></DIV
 187 ></BODY
 188 ></HTML
 189 >