lwres_inetntop.docbook revision ec5347e2c775f027573ce5648b910361aa926c01
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington [<!ENTITY mdash "&#8212;">]>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<!--
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - Copyright (C) 2000, 2001 Internet Software Consortium.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington -
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - Permission to use, copy, modify, and/or distribute this software for any
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - purpose with or without fee is hereby granted, provided that the above
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - copyright notice and this permission notice appear in all copies.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington -
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence - PERFORMANCE OF THIS SOFTWARE.
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence-->
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington<!-- $Id: lwres_inetntop.docbook,v 1.10 2007/06/18 23:47:51 tbox Exp $ -->
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence<refentry>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <refentryinfo>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <date>Jun 30, 2000</date>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </refentryinfo>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <refmeta>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <refentrytitle>lwres_inetntop</refentrytitle>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <manvolnum>3</manvolnum>
e4757e3dafe50ae59f693eec828f68c42c197a70Andreas Gustafsson <refmiscinfo>BIND9</refmiscinfo>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </refmeta>
f9d068745ddfeb513db6184d9dddde835bed42d4Andreas Gustafsson
e4757e3dafe50ae59f693eec828f68c42c197a70Andreas Gustafsson <docinfo>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews <copyright>
e4757e3dafe50ae59f693eec828f68c42c197a70Andreas Gustafsson <year>2004</year>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <year>2005</year>
f9d068745ddfeb513db6184d9dddde835bed42d4Andreas Gustafsson <year>2007</year>
e4757e3dafe50ae59f693eec828f68c42c197a70Andreas Gustafsson <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </copyright>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <copyright>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <year>2000</year>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <year>2001</year>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <holder>Internet Software Consortium.</holder>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </copyright>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </docinfo>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <refnamediv>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <refname>lwres_net_ntop</refname>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <refpurpose>lightweight resolver IP address presentation</refpurpose>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </refnamediv>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <refsynopsisdiv>
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence <funcsynopsis>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews<funcsynopsisinfo>#include &lt;lwres/net.h&gt;</funcsynopsisinfo>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews<funcprototype>
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence <funcdef>
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrenceconst char *
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<function>lwres_net_ntop</function></funcdef>
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington <paramdef>int <parameter>af</parameter></paramdef>
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence <paramdef>const void *<parameter>src</parameter></paramdef>
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence <paramdef>char *<parameter>dst</parameter></paramdef>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <paramdef>size_t <parameter>size</parameter></paramdef>
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington </funcprototype>
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence</funcsynopsis>
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence </refsynopsisdiv>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington <refsect1>
09ab886382ad9e7149d9b72b4cf9a03ae4a1cddfDavid Lawrence <title>DESCRIPTION</title>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <para><function>lwres_net_ntop()</function>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson converts an IP address of protocol family
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <parameter>af</parameter> &mdash; IPv4 or IPv6 &mdash; at
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson location <parameter>src</parameter> from network format to its
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson conventional representation as a string. For IPv4 addresses,
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson that string would be a dotted-decimal. An IPv6 address would be
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson represented in colon notation as described in RFC1884.
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </para>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <para>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson The generated string is copied to <parameter>dst</parameter>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson provided
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <parameter>size</parameter> indicates it is long enough to
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson store the
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson ASCII representation of the address.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews </refsect1>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews <refsect1>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews <title>RETURN VALUES</title>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews <para>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews If successful, the function returns <parameter>dst</parameter>:
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington a pointer to a string containing the presentation format of the
17453368fa0136f6287c56d6600bee58809334bcAndreas Gustafsson address. <function>lwres_net_ntop()</function> returns
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews <type>NULL</type> and sets the global variable
90c099e88e9f16bfee9edee3ac1a51fc98843772Brian Wellington <constant>errno</constant> to <errorcode>EAFNOSUPPORT</errorcode> if
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews the protocol family given in <parameter>af</parameter> is
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington not
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington supported.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </refsect1>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <refsect1>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <title>SEE ALSO</title>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <para><citerefentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <refentrytitle>RFC1884</refentrytitle>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </citerefentry>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <citerefentry>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews <refentrytitle>inet_ntop</refentrytitle><manvolnum>3</manvolnum>
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews </citerefentry>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <citerefentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </citerefentry>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </refsect1>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington</refentry><!--
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews - Local variables:
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - mode: sgml
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - End:
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington-->
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington