contrib/bind9/lib/lwres/man/lwres_inetntop.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004, 2005  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000, 2001  Internet Software Consortium.
   7  -
   8  - Permission to use, copy, modify, and distribute this software for any
   9  - purpose with or without fee is hereby granted, provided that the above
  10  - copyright notice and this permission notice appear in all copies.
  11  -
  12  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  13  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  14  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  15  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  16  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  17  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  18  - PERFORMANCE OF THIS SOFTWARE.
  19 -->
  20
  21 <!-- $Id: lwres_inetntop.docbook,v 1.3.206.3 2005/05/12 21:36:15 sra Exp $ -->
  22
  23 <refentry>
  24
  25 <refentryinfo>
  26 <date>Jun 30, 2000</date>
  27 </refentryinfo>
  28
  29 <refmeta>
  30 <refentrytitle>lwres_inetntop</refentrytitle>
  31 <manvolnum>3</manvolnum>
  32 <refmiscinfo>BIND9</refmiscinfo>
  33 </refmeta>
  34
  35   <docinfo>
  36     <copyright>
  37       <year>2004</year>
  38       <year>2005</year>
  39       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  40     </copyright>
  41     <copyright>
  42       <year>2000</year>
  43       <year>2001</year>
  44       <holder>Internet Software Consortium.</holder>
  45     </copyright>
  46   </docinfo>
  47
  48 <refnamediv>
  49 <refname>lwres_net_ntop</refname>
  50 <refpurpose>lightweight resolver IP address presentation</refpurpose>
  51 </refnamediv>
  52 <refsynopsisdiv>
  53 <funcsynopsis>
  54 <funcsynopsisinfo>#include &lt;lwres/net.h&gt;</funcsynopsisinfo>
  55 <funcprototype>
  56 <funcdef>
  57 const char *
  58 <function>lwres_net_ntop</function></funcdef>
  59 <paramdef>int af</paramdef>
  60 <paramdef>const void *src</paramdef>
  61 <paramdef>char *dst</paramdef>
  62 <paramdef>size_t size</paramdef>
  63 </funcprototype>
  64 </funcsynopsis>
  65 </refsynopsisdiv>
  66
  67 <refsect1>
  68 <title>DESCRIPTION</title>
  69
  70 <para>
  71 <function>lwres_net_ntop()</function> converts an IP address of
  72 protocol family <parameter>af</parameter> &mdash; IPv4 or IPv6 &mdash;
  73 at location <parameter>src</parameter> from network format to its
  74 conventional representation as a string.  For IPv4 addresses, that
  75 string would be a dotted-decimal.  An IPv6 address would be
  76 represented in colon notation as described in RFC1884.
  77 </para>
  78
  79 <para>
  80 The generated string is copied to <parameter>dst</parameter> provided
  81 <parameter>size</parameter> indicates it is long enough to store the
  82 ASCII representation of the address.
  83 </para>
  84
  85 </refsect1>
  86 <refsect1>
  87 <title>RETURN VALUES</title>
  88
  89 <para>
  90 If successful, the function returns <parameter>dst</parameter>:
  91 a pointer to a string containing the presentation format of the
  92 address.  <function>lwres_net_ntop()</function> returns
  93 <type>NULL</type> and sets the global variable
  94 <constant>errno</constant> to <errorcode>EAFNOSUPPORT</errorcode> if
  95 the protocol family given in <parameter>af</parameter> is not
  96 supported.
  97 </para>
  98
  99 </refsect1>
 100 <refsect1>
 101 <title>SEE ALSO</title>
 102 <para>
 103 <citerefentry>
 104 <refentrytitle>RFC1884</refentrytitle>
 105 </citerefentry>,
 106 <citerefentry>
 107 <refentrytitle>inet_ntop</refentrytitle><manvolnum>3</manvolnum>
 108 </citerefentry>,
 109 <citerefentry>
 110 <refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum>
 111 </citerefentry>.
 112 </para>
 113 </refsect1>
 114 </refentry>