]>

 - Copyright (C) Internet Systems Consortium, Inc. ("ISC")

 -

 - This Source Code Form is subject to the terms of the Mozilla Public

 - License, v. 2.0. If a copy of the MPL was not distributed with this

 - file, You can obtain one at http://mozilla.org/MPL/2.0/.

 -

 - See the COPYRIGHT file distributed with this work for additional

 - information regarding copyright ownership.

-->

<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0">

  <info>

    <date>2007-06-18</date>

  </info>

  <refentryinfo>

    <corpname>ISC</corpname>

    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>

  </refentryinfo>

  <refmeta>

    <refentrytitle>lwres_inetntop</refentrytitle>

    <manvolnum>3</manvolnum>

    <refmiscinfo>BIND9</refmiscinfo>

  </refmeta>

  <docinfo>

    <copyright>

      <year>2000</year>

      <year>2001</year>

      <year>2004</year>

      <year>2005</year>

      <year>2007</year>

      <year>2014</year>

      <year>2015</year>

      <year>2016</year>

      <year>2018</year>

      <year>2019</year>

      <year>2020</year>

      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

    </copyright>

  </docinfo>

  <refnamediv>

    <refname>lwres_net_ntop</refname>

    <refpurpose>lightweight resolver IP address presentation</refpurpose>

  </refnamediv>

  <refsynopsisdiv>

    <funcsynopsis>

<funcsynopsisinfo>#include <lwres/net.h></funcsynopsisinfo>

<funcprototype>

        <funcdef>

const char *

<function>lwres_net_ntop</function></funcdef>

        <paramdef>int <parameter>af</parameter></paramdef>

        <paramdef>const void *<parameter>src</parameter></paramdef>

        <paramdef>char *<parameter>dst</parameter></paramdef>

        <paramdef>size_t <parameter>size</parameter></paramdef>

      </funcprototype>

</funcsynopsis>

  </refsynopsisdiv>

  <refsection><info><title>DESCRIPTION</title></info>

    <para><function>lwres_net_ntop()</function>

      converts an IP address of protocol family

      <parameter>af</parameter> — IPv4 or IPv6 — at

      location <parameter>src</parameter> from network format to its

      conventional representation as a string.  For IPv4 addresses,

      that string would be a dotted-decimal.  An IPv6 address would be

      represented in colon notation as described in RFC1884.

    </para>

    <para>

      The generated string is copied to <parameter>dst</parameter>

      provided

      <parameter>size</parameter> indicates it is long enough to

      store the

      ASCII representation of the address.

    </para>

  </refsection>

  <refsection><info><title>RETURN VALUES</title></info>

    <para>

      If successful, the function returns <parameter>dst</parameter>:

      a pointer to a string containing the presentation format of the

      address.  <function>lwres_net_ntop()</function> returns

      <type>NULL</type> and sets the global variable

      <constant>errno</constant> to <errorcode>EAFNOSUPPORT</errorcode> if

      the protocol family given in <parameter>af</parameter> is

      not

      supported.

    </para>

  </refsection>

  <refsection><info><title>SEE ALSO</title></info>

    <para><citerefentry>

        <refentrytitle>RFC1884</refentrytitle>

      </citerefentry>,

      <citerefentry>

        <refentrytitle>inet_ntop</refentrytitle><manvolnum>3</manvolnum>

      </citerefentry>,

      <citerefentry>

        <refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum>

      </citerefentry>.

    </para>

  </refsection>

</refentry>