lwres_inetntop.docbook revision d4ef65050feac78554addf6e16a06c6e2e0bd331
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!--
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - Copyright (C) 2001 Internet Software Consortium.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews -
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - Permission to use, copy, modify, and distribute this software for any
9bff67898d55cddfcec9ce30cc2b1bb6211ec691David Lawrence - purpose with or without fee is hereby granted, provided that the above
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - copyright notice and this permission notice appear in all copies.
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff -
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff-->
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff<!-- $Id: lwres_inetntop.docbook,v 1.2 2001/04/10 21:52:00 bwelling Exp $ -->
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff<refentry>
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff<refentryinfo>
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff<date>Jun 30, 2000</date>
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff</refentryinfo>
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff<refmeta>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refentrytitle>lwres_inetntop</refentrytitle>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<manvolnum>3</manvolnum>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refmiscinfo>BIND9</refmiscinfo>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</refmeta>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refnamediv>
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff<refname>lwres_net_ntop</refname>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refpurpose>lightweight resolver IP address presentation</refpurpose>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</refnamediv>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refsynopsisdiv>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<funcsynopsis>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<funcsynopsisinfo>#include &lt;lwres/net.h&gt;</funcsynopsisinfo>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<funcprototype>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<funcdef>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffconst char *
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<function>lwres_net_ntop</function></funcdef>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<paramdef>int af</paramdef>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<paramdef>const void *src</paramdef>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<paramdef>char *dst</paramdef>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<paramdef>size_t size</paramdef>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</funcprototype>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</funcsynopsis>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</refsynopsisdiv>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refsect1>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<title>DESCRIPTION</title>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<para>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<function>lwres_net_ntop()</function>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffconverts an IP address of protocol family
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<parameter>af</parameter>
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff&mdash; IPv4 or IPv6 &mdash;
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffat location
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<parameter>src</parameter>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Grafffrom network format to its conventional representation as a string.
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael GraffFor IPv4 addresses, that string would be a dotted-decimal.
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael GraffAn IPv6 address would be represented in colon notation as described in
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael GraffRFC1884.
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</para>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<para>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael GraffThe generated string is copied to
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff<parameter>dst</parameter>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffprovided
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<parameter>size</parameter>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffindicates it is long enough to store the ASCII representation
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffof the address.
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</para>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</refsect1>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refsect1>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<title>RETURN VALUES</title>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<para>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael GraffIf successful, the function returns
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<parameter>dst</parameter>:
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffa pointer to a string containing
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffthe presentation format of the address.
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<function>lwres_net_ntop()</function>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffreturns
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<type>NULL</type>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffand sets the global variable
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<constant>errno</constant>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffto
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<errorcode>EAFNOSUPPORT</errorcode>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffif the protocol family given in
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<parameter>af</parameter>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graffis not supported.
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff</para>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</refsect1>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refsect1>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<title>SEE ALSO</title>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<para>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<citerefentry>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refentrytitle>RFC1884</refentrytitle>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</citerefentry>,
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<citerefentry>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refentrytitle>inet_ntop</refentrytitle><manvolnum>3</manvolnum>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</citerefentry>,
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<citerefentry>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff<refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum>
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</citerefentry>.
2358fd9353e91bc2291c165a679af9b3a1b7fb3aMichael Graff</para>
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff</refsect1>
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff</refentry>
0982a13bcfef0d9a443248bcf929042b460613a9Michael Graff