lwres_config.html revision 75c0816e8295e180f4bc7f10db3d0d880383bc1c
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!--
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - Copyright (C) 2000, 2001 Internet Software Consortium.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe -
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - Permission to use, copy, modify, and distribute this software for any
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - purpose with or without fee is hereby granted, provided that the above
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - copyright notice and this permission notice appear in all copies.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe -
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - PERFORMANCE OF THIS SOFTWARE.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe-->
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!-- $Id: lwres_config.html,v 1.13 2005/05/13 03:14:12 marka Exp $ -->
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<html>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<head>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<title>lwres_config</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe</head>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<a name="id2456836"></a><div class="titlepage"></div>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<div class="refnamediv">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<h2>Name</h2>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<p>lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get &#8212; lightweight resolver configuration</p>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe</div>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<div class="refsynopsisdiv">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<h2>Synopsis</h2>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<div class="funcsynopsis">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<pre class="funcsynopsisinfo">#include &lt;lwres/lwres.h&gt;</pre>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td><code class="funcdef">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowevoid
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<b class="fsfunc">lwres_conf_init</b>(</code></td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>lwres_context_t *�</td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<var class="pdparam">ctx</var><code>)</code>;</td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe</tr></table>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td><code class="funcdef">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowevoid
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<b class="fsfunc">lwres_conf_clear</b>(</code></td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>lwres_context_t *�</td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<var class="pdparam">ctx</var><code>)</code>;</td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe</tr></table>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<tr>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td><code class="funcdef">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowelwres_result_t
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<b class="fsfunc">lwres_conf_parse</b>(</code></td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>lwres_context_t *�</td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<var class="pdparam">ctx</var>, </td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe</tr>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<tr>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>�</td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>const char *�</td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<var class="pdparam">filename</var><code>)</code>;</td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe</tr>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe</table>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<tr>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td><code class="funcdef">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowelwres_result_t
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<b class="fsfunc">lwres_conf_print</b>(</code></td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>lwres_context_t *�</td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<td>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<var class="pdparam">ctx</var>, </td>
</tr>
<tr>
<td>�</td>
<td>FILE *�</td>
<td>
<var class="pdparam">fp</var><code>)</code>;</td>
</tr>
</table>
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
<td><code class="funcdef">
lwres_conf_t *
<b class="fsfunc">lwres_conf_get</b>(</code></td>
<td>lwres_context_t *�</td>
<td>
<var class="pdparam">ctx</var><code>)</code>;</td>
</tr></table>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2514266"></a><h2>DESCRIPTION</h2>
<p><code class="function">lwres_conf_init()</code>
creates an empty
<span class="type">lwres_conf_t</span>
structure for lightweight resolver context
<em class="parameter"><code>ctx</code></em>.
</p>
<p><code class="function">lwres_conf_clear()</code>
frees up all the internal memory used by
that
<span class="type">lwres_conf_t</span>
structure in resolver context
<em class="parameter"><code>ctx</code></em>.
</p>
<p><code class="function">lwres_conf_parse()</code>
opens the file
<em class="parameter"><code>filename</code></em>
and parses it to initialise the resolver context
<em class="parameter"><code>ctx</code></em>'s
<span class="type">lwres_conf_t</span>
structure.
</p>
<p><code class="function">lwres_conf_print()</code>
prints the
<span class="type">lwres_conf_t</span>
structure for resolver context
<em class="parameter"><code>ctx</code></em>
to the
<span class="type">FILE</span>
<em class="parameter"><code>fp</code></em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2514333"></a><h2>RETURN VALUES</h2>
<p><code class="function">lwres_conf_parse()</code>
returns <span class="errorcode">LWRES_R_SUCCESS</span>
if it successfully read and parsed
<em class="parameter"><code>filename</code></em>.
It returns <span class="errorcode">LWRES_R_FAILURE</span>
if <em class="parameter"><code>filename</code></em>
could not be opened or contained incorrect
resolver statements.
</p>
<p><code class="function">lwres_conf_print()</code>
returns <span class="errorcode">LWRES_R_SUCCESS</span>
unless an error occurred when converting the network addresses to a
numeric host address string.
If this happens, the function returns
<span class="errorcode">LWRES_R_FAILURE</span>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2514371"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">stdio</span>(3)</span>,
<span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2514396"></a><h2>FILES</h2>
<p><code class="filename">/etc/resolv.conf</code>
</p>
</div>
</div></body>
</html>