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