lwres_inetntop.docbook revision c651f15b30f1dae5cc2f00878fb5da5b3a35a468
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews - Copyright (C) 2000, 2001 Internet Software Consortium.
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - Permission to use, copy, modify, and distribute this software for any
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - purpose with or without fee is hereby granted, provided that the above
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - copyright notice and this permission notice appear in all copies.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<!-- $Id: lwres_inetntop.docbook,v 1.5 2005/04/07 03:50:03 marka Exp $ -->
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley<refentryinfo>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley</refentryinfo>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley<refpurpose>lightweight resolver IP address presentation</refpurpose>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley</refnamediv>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley<refsynopsisdiv>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley<funcsynopsis>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley<funcsynopsisinfo>#include <lwres/net.h></funcsynopsisinfo>
c4f9e613e12f03795bee18cf2ca8e6a9d39d6468Mark Andrews<funcprototype>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley</funcprototype>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley</funcsynopsis>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley</refsynopsisdiv>
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley<function>lwres_net_ntop()</function> converts an IP address of
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleyprotocol family <parameter>af</parameter> — IPv4 or IPv6 —
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleyat location <parameter>src</parameter> from network format to its
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleyconventional representation as a string. For IPv4 addresses, that
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleystring would be a dotted-decimal. An IPv6 address would be
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleyrepresented in colon notation as described in RFC1884.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob HalleyThe generated string is copied to <parameter>dst</parameter> provided
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley<parameter>size</parameter> indicates it is long enough to store the
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob HalleyASCII representation of the address.
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob HalleyIf successful, the function returns <parameter>dst</parameter>:
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleya pointer to a string containing the presentation format of the
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleyaddress. <function>lwres_net_ntop()</function> returns
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley<constant>errno</constant> to <errorcode>EAFNOSUPPORT</errorcode> if
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halleythe protocol family given in <parameter>af</parameter> is not
c4f9e613e12f03795bee18cf2ca8e6a9d39d6468Mark Andrews<citerefentry>
c4f9e613e12f03795bee18cf2ca8e6a9d39d6468Mark Andrews</citerefentry>,
c4f9e613e12f03795bee18cf2ca8e6a9d39d6468Mark Andrews<citerefentry>
c4f9e613e12f03795bee18cf2ca8e6a9d39d6468Mark Andrews<refentrytitle>inet_ntop</refentrytitle><manvolnum>3</manvolnum>
c4f9e613e12f03795bee18cf2ca8e6a9d39d6468Mark Andrews</citerefentry>,
c4f9e613e12f03795bee18cf2ca8e6a9d39d6468Mark Andrews<citerefentry>
c4f9e613e12f03795bee18cf2ca8e6a9d39d6468Mark Andrews<refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum>
c4f9e613e12f03795bee18cf2ca8e6a9d39d6468Mark Andrews</citerefentry>.