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