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