lwres_config.docbook revision 268a4475065fe6a8cd7cc707820982cf5e98f430
2N/A<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
2N/A "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
2N/A [<!ENTITY mdash "&#8212;">]>
2N/A<!--
2N/A - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
2N/A - Copyright (C) 2000, 2001 Internet Software Consortium.
2N/A -
2N/A - Permission to use, copy, modify, and distribute this software for any
2N/A - purpose with or without fee is hereby granted, provided that the above
2N/A - copyright notice and this permission notice appear in all copies.
2N/A -
2N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2N/A - PERFORMANCE OF THIS SOFTWARE.
2N/A-->
2N/A<!-- $Id: lwres_config.docbook,v 1.5 2005/05/11 05:55:39 sra Exp $ -->
2N/A<refentry>
2N/A <refentryinfo>
2N/A
2N/A <date>Jun 30, 2000</date>
2N/A </refentryinfo>
2N/A
2N/A <refmeta>
2N/A <refentrytitle>lwres_config</refentrytitle>
2N/A <manvolnum>3</manvolnum>
2N/A <refmiscinfo>BIND9</refmiscinfo>
2N/A </refmeta>
2N/A
2N/A <docinfo>
2N/A <copyright>
2N/A <year>2004</year>
2N/A <year>2005</year>
2N/A <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
2N/A </copyright>
2N/A <copyright>
2N/A <year>2000</year>
2N/A <year>2001</year>
2N/A <holder>Internet Software Consortium</holder>
2N/A </copyright>
2N/A </docinfo>
2N/A
2N/A <refnamediv>
2N/A <refname>lwres_conf_init</refname>
2N/A <refname>lwres_conf_clear</refname>
2N/A <refname>lwres_conf_parse</refname>
2N/A <refname>lwres_conf_print</refname>
2N/A <refname>lwres_conf_get</refname>
2N/A <refpurpose>lightweight resolver configuration</refpurpose>
2N/A </refnamediv>
2N/A
2N/A <refsynopsisdiv>
2N/A <funcsynopsis>
2N/A<funcsynopsisinfo>#include &lt;lwres/lwres.h&gt;</funcsynopsisinfo>
2N/A<funcprototype>
2N/A <funcdef>
2N/Avoid
2N/A<function>lwres_conf_init</function></funcdef>
2N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
2N/A </funcprototype>
2N/A<funcprototype>
2N/A <funcdef>
2N/Avoid
2N/A<function>lwres_conf_clear</function></funcdef>
2N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
2N/A </funcprototype>
2N/A<funcprototype>
2N/A <funcdef>
2N/Alwres_result_t
2N/A<function>lwres_conf_parse</function></funcdef>
2N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
2N/A <paramdef>const char *<parameter>filename</parameter></paramdef>
2N/A </funcprototype>
2N/A<funcprototype>
2N/A <funcdef>
2N/Alwres_result_t
2N/A<function>lwres_conf_print</function></funcdef>
2N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
2N/A <paramdef>FILE *<parameter>fp</parameter></paramdef>
2N/A </funcprototype>
2N/A<funcprototype>
2N/A <funcdef>
2N/Alwres_conf_t *
2N/A<function>lwres_conf_get</function></funcdef>
2N/A <paramdef>lwres_context_t *<parameter>ctx</parameter></paramdef>
2N/A </funcprototype>
2N/A</funcsynopsis>
2N/A </refsynopsisdiv>
2N/A
2N/A <refsect1>
2N/A <title>DESCRIPTION</title>
2N/A
2N/A <para><function>lwres_conf_init()</function>
2N/A creates an empty
2N/A <type>lwres_conf_t</type>
2N/A structure for lightweight resolver context
2N/A <parameter>ctx</parameter>.
2N/A </para>
2N/A
2N/A <para><function>lwres_conf_clear()</function>
2N/A frees up all the internal memory used by
2N/A that
2N/A <type>lwres_conf_t</type>
2N/A structure in resolver context
2N/A <parameter>ctx</parameter>.
2N/A </para>
2N/A
2N/A <para><function>lwres_conf_parse()</function>
2N/A opens the file
2N/A <parameter>filename</parameter>
2N/A and parses it to initialise the resolver context
2N/A <parameter>ctx</parameter>'s
2N/A <type>lwres_conf_t</type>
2N/A structure.
2N/A </para>
2N/A
2N/A <para><function>lwres_conf_print()</function>
2N/A prints the
2N/A <type>lwres_conf_t</type>
2N/A structure for resolver context
2N/A <parameter>ctx</parameter>
2N/A to the
2N/A <type>FILE</type>
2N/A <parameter>fp</parameter>.
2N/A </para>
2N/A </refsect1>
2N/A <refsect1>
2N/A
2N/A <title>RETURN VALUES</title>
2N/A
2N/A <para><function>lwres_conf_parse()</function>
2N/A returns <errorcode>LWRES_R_SUCCESS</errorcode>
2N/A if it successfully read and parsed
2N/A <parameter>filename</parameter>.
2N/A It returns <errorcode>LWRES_R_FAILURE</errorcode>
2N/A if <parameter>filename</parameter>
2N/A could not be opened or contained incorrect
2N/A resolver statements.
2N/A </para>
2N/A
2N/A <para><function>lwres_conf_print()</function>
2N/A returns <errorcode>LWRES_R_SUCCESS</errorcode>
2N/A unless an error occurred when converting the network addresses to a
2N/A numeric host address string.
2N/A If this happens, the function returns
2N/A <errorcode>LWRES_R_FAILURE</errorcode>.
2N/A </para>
2N/A </refsect1>
2N/A <refsect1>
2N/A <title>SEE ALSO</title>
2N/A <para><citerefentry>
2N/A <refentrytitle>stdio</refentrytitle><manvolnum>3</manvolnum>
2N/A </citerefentry>,
2N/A <citerefentry>
2N/A <refentrytitle>resolver</refentrytitle><manvolnum>5</manvolnum>
2N/A </citerefentry>.
2N/A </para>
2N/A </refsect1>
2N/A <refsect1>
2N/A <title>FILES</title>
2N/A <para><filename>/etc/resolv.conf</filename>
2N/A </para>
2N/A </refsect1>
2N/A</refentry><!--
2N/A - Local variables:
2N/A - mode: sgml
2N/A - End:
2N/A-->
2N/A