170 lines
5.4 KiB
HTML
170 lines
5.4 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<!--
|
||
- Copyright (C) 2000, 2001, 2004, 2005, 2007, 2014-2016 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/.
|
||
-->
|
||
<html lang="en">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||
<title>lwres_config</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
|
||
<a name="id-1"></a><div class="titlepage"></div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="refnamediv">
|
||
<h2>Name</h2>
|
||
<p>
|
||
lwres_conf_init,
|
||
lwres_conf_clear,
|
||
lwres_conf_parse,
|
||
lwres_conf_print,
|
||
lwres_conf_get
|
||
— lightweight resolver configuration
|
||
</p>
|
||
</div>
|
||
|
||
<div class="refsynopsisdiv">
|
||
<h2>Synopsis</h2>
|
||
<div class="funcsynopsis">
|
||
<pre class="funcsynopsisinfo">#include <lwres/lwres.h></pre>
|
||
<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
|
||
<td><code class="funcdef">
|
||
void
|
||
<b class="fsfunc">lwres_conf_init</b>(</code></td>
|
||
<td>lwres_context_t *<var class="pdparam">ctx</var><code>)</code>;</td>
|
||
</tr></table>
|
||
<div class="funcprototype-spacer"> </div>
|
||
<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
|
||
<td><code class="funcdef">
|
||
void
|
||
<b class="fsfunc">lwres_conf_clear</b>(</code></td>
|
||
<td>lwres_context_t *<var class="pdparam">ctx</var><code>)</code>;</td>
|
||
</tr></table>
|
||
<div class="funcprototype-spacer"> </div>
|
||
<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
|
||
<tr>
|
||
<td><code class="funcdef">
|
||
lwres_result_t
|
||
<b class="fsfunc">lwres_conf_parse</b>(</code></td>
|
||
<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td> </td>
|
||
<td>const char *<var class="pdparam">filename</var><code>)</code>;</td>
|
||
</tr>
|
||
</table>
|
||
<div class="funcprototype-spacer"> </div>
|
||
<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
|
||
<tr>
|
||
<td><code class="funcdef">
|
||
lwres_result_t
|
||
<b class="fsfunc">lwres_conf_print</b>(</code></td>
|
||
<td>lwres_context_t *<var class="pdparam">ctx</var>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td> </td>
|
||
<td>FILE *<var class="pdparam">fp</var><code>)</code>;</td>
|
||
</tr>
|
||
</table>
|
||
<div class="funcprototype-spacer"> </div>
|
||
<table border="0" class="funcprototype-table" summary="Function synopsis" style="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 *<var class="pdparam">ctx</var><code>)</code>;</td>
|
||
</tr></table>
|
||
<div class="funcprototype-spacer"> </div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="refsection">
|
||
<a name="id-1.7"></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="refsection">
|
||
<a name="id-1.8"></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="refsection">
|
||
<a name="id-1.9"></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="refsection">
|
||
<a name="id-1.10"></a><h2>FILES</h2>
|
||
|
||
<p><code class="filename">/etc/resolv.conf</code>
|
||
</p>
|
||
</div>
|
||
</div></body>
|
||
</html>
|