lwres_config.docbook revision 30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1
5398N/A<!--
5398N/A - Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
5398N/A - Copyright (C) 2000, 2001 Internet Software Consortium.
5398N/A -
5398N/A - Permission to use, copy, modify, and/or distribute this software for any
5398N/A - purpose with or without fee is hereby granted, provided that the above
5398N/A - copyright notice and this permission notice appear in all copies.
5398N/A -
5398N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
5398N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
5398N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
5398N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5398N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5398N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
5398N/A - PERFORMANCE OF THIS SOFTWARE.
5398N/A-->
5398N/A
5398N/A<!-- Converted by db4-upgrade version 1.0 -->
5398N/A<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
5398N/A <info>
5398N/A <date>2007-06-18</date>
5398N/A </info>
5398N/A <refentryinfo>
5398N/A <corpname>ISC</corpname>
5680N/A <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
5680N/A </refentryinfo>
5680N/A
5680N/A <refmeta>
5680N/A <refentrytitle>lwres_config</refentrytitle>
5398N/A <manvolnum>3</manvolnum>
5398N/A <refmiscinfo>BIND9</refmiscinfo>
5398N/A </refmeta>
5559N/A
5398N/A <docinfo>
5398N/A <copyright>
5559N/A <year>2004</year>
5559N/A <year>2005</year>
5398N/A <year>2007</year>
5398N/A <year>2014</year>
5559N/A <year>2015</year>
5398N/A <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
5680N/A </copyright>
5680N/A <copyright>
5398N/A <year>2000</year>
5398N/A <year>2001</year>
5398N/A <holder>Internet Software Consortium.</holder>
5398N/A </copyright>
5398N/A </docinfo>
5398N/A
5398N/A <refnamediv>
5398N/A <refname>lwres_conf_init</refname>
5398N/A <refname>lwres_conf_clear</refname>
5398N/A <refname>lwres_conf_parse</refname>
5398N/A <refname>lwres_conf_print</refname>
5680N/A <refname>lwres_conf_get</refname>
5680N/A <refpurpose>lightweight resolver configuration</refpurpose>
5680N/A </refnamediv>
5680N/A
5680N/A <refsynopsisdiv>
5680N/A <funcsynopsis>
5680N/A<funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
5680N/A<funcprototype>
5680N/A <funcdef>
5680N/Avoid
5398N/A<function>lwres_conf_init</function></funcdef>
5398N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
5680N/A </funcprototype>
5398N/A<funcprototype>
5398N/A <funcdef>
5398N/Avoid
5398N/A<function>lwres_conf_clear</function></funcdef>
5398N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
5398N/A </funcprototype>
5398N/A<funcprototype>
5398N/A <funcdef>
5398N/Alwres_result_t
5398N/A<function>lwres_conf_parse</function></funcdef>
5636N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
5636N/A <paramdef>const char *<parameter>filename</parameter></paramdef>
5398N/A </funcprototype>
5398N/A<funcprototype>
5398N/A <funcdef>
5398N/Alwres_result_t
5398N/A<function>lwres_conf_print</function></funcdef>
5398N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
5398N/A <paramdef>FILE *<parameter>fp</parameter></paramdef>
5398N/A </funcprototype>
5398N/A<funcprototype>
5398N/A <funcdef>
5398N/Alwres_conf_t *
5398N/A<function>lwres_conf_get</function></funcdef>
5398N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
5398N/A </funcprototype>
5398N/A</funcsynopsis>
5398N/A </refsynopsisdiv>
5398N/A
5398N/A <refsection><info><title>DESCRIPTION</title></info>
5398N/A
5398N/A
5398N/A <para><function>lwres_conf_init()</function>
5398N/A creates an empty
5398N/A <type>lwres_conf_t</type>
5398N/A structure for lightweight resolver context
5398N/A <parameter>ctx</parameter>.
5398N/A </para>
5398N/A
5398N/A <para><function>lwres_conf_clear()</function>
5398N/A frees up all the internal memory used by
5398N/A that
5398N/A <type>lwres_conf_t</type>
5398N/A structure in resolver context
5398N/A <parameter>ctx</parameter>.
5398N/A </para>
5398N/A
5398N/A <para><function>lwres_conf_parse()</function>
5398N/A opens the file
5398N/A <parameter>filename</parameter>
5398N/A and parses it to initialise the resolver context
5398N/A <parameter>ctx</parameter>'s
5398N/A <type>lwres_conf_t</type>
5398N/A structure.
5398N/A </para>
5398N/A
5398N/A <para><function>lwres_conf_print()</function>
5398N/A prints the
5398N/A <type>lwres_conf_t</type>
5398N/A structure for resolver context
5398N/A <parameter>ctx</parameter>
5398N/A to the
5398N/A <type>FILE</type>
5398N/A <parameter>fp</parameter>.
5398N/A </para>
5398N/A </refsection>
5398N/A <refsection><info><title>RETURN VALUES</title></info>
5398N/A
5398N/A
5398N/A
5398N/A <para><function>lwres_conf_parse()</function>
5398N/A returns <errorcode>LWRES_R_SUCCESS</errorcode>
5398N/A if it successfully read and parsed
5398N/A <parameter>filename</parameter>.
5398N/A It returns <errorcode>LWRES_R_FAILURE</errorcode>
5398N/A if <parameter>filename</parameter>
5398N/A could not be opened or contained incorrect
5398N/A resolver statements.
5398N/A </para>
5398N/A
5398N/A <para><function>lwres_conf_print()</function>
5398N/A returns <errorcode>LWRES_R_SUCCESS</errorcode>
5398N/A unless an error occurred when converting the network addresses to a
5398N/A numeric host address string.
5636N/A If this happens, the function returns
5398N/A <errorcode>LWRES_R_FAILURE</errorcode>.
5398N/A </para>
5398N/A </refsection>
5398N/A <refsection><info><title>SEE ALSO</title></info>
5398N/A
5398N/A <para><citerefentry>
5398N/A <refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
5398N/A </citerefentry>,
5398N/A <citerefentry>
5398N/A <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
5398N/A </citerefentry>.
5398N/A </para>
</refsection>
<refsection><info><title>FILES</title></info>
<para><filename>/etc/resolv.conf</filename>
</para>
</refsection>
</refentry>