lwres_config.html revision 71c66a876ecca77923638d3f94cc0783152b2f03
012a352f4b26cfd874db8d06debc495c2303e8b2Bob Halley<!--
178f6ad061e54bc5babfca3577f72058fa0797c1Bob Halley - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
24a4fabc0b0508a2d2b4651454dba1dfa93968f2Tinderbox User - Copyright (C) 2000, 2001 Internet Software Consortium.
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews -
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - Permission to use, copy, modify, and distribute this software for any
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - purpose with or without fee is hereby granted, provided that the above
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - copyright notice and this permission notice appear in all copies.
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews -
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews-->
b897c52f865b2fc4e220e2110b874e59c716456bBob Halley<!-- $Id: lwres_config.html,v 1.19 2006/06/29 13:03:32 marka Exp $ -->
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User<html>
9c3531d72aeaad6c5f01efe6a1c82023e1379e4dDavid Lawrence<head>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<title>lwres_config</title>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt</head>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<a name="id2482688"></a><div class="titlepage"></div>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<div class="refnamediv">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<h2>Name</h2>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<p>lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get &#8212; lightweight resolver configuration</p>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt</div>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<div class="refsynopsisdiv">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<h2>Synopsis</h2>
b897c52f865b2fc4e220e2110b874e59c716456bBob Halley<div class="funcsynopsis">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<pre class="funcsynopsisinfo">#include &lt;lwres/lwres.h&gt;</pre>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<tr>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<td><code class="funcdef">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halleyvoid
b897c52f865b2fc4e220e2110b874e59c716456bBob Halley<b class="fsfunc">lwres_conf_init</b>(</code></td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<td>�</td>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<td>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<var class="pdparam">ctx</var><code>)</code>;</td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt</tr>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<tr>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<td>�</td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<td>�</td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<var class="pdparam">ctx</var><code>)</code>;</td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt</tr>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt</table>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<tr>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<td><code class="funcdef">
460b427411b72da26b1836b9424e2e70d65d9394David Lawrencevoid
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<b class="fsfunc">lwres_conf_clear</b>(</code></td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<td>�</td>
fcb54ce0a4f7377486df5bec83b3aa4711bf4131Mark Andrews<td>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<var class="pdparam">ctx</var><code>)</code>;</td>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence</tr>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<tr>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<td>�</td>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<td>�</td>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<td>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<var class="pdparam">ctx</var><code>)</code>;</td>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence</tr>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt</table>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<tr>
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews<td><code class="funcdef">
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrewslwres_result_t
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews<b class="fsfunc">lwres_conf_parse</b>(</code></td>
12a3ab37fe6556406acdf92fc7c5f198d603ca2eMark Andrews<td>�</td>
f5cfcbf2f7906fb59c2b8b9b8fc9c7a75ac44dabMark Andrews<td>
2d46d268ccff30bb50e661b47c6496d23d9156c7Mark Andrews<var class="pdparam">ctx</var>, </td>
2d46d268ccff30bb50e661b47c6496d23d9156c7Mark Andrews</tr>
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews<tr>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<td>�</td>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<td>�</td>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<td>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<var class="pdparam">ctx</var>, </td>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence</tr>
2d9bd38ec3fbbfe920757b8972d94f664a9b354bMark Andrews<tr>
2d9bd38ec3fbbfe920757b8972d94f664a9b354bMark Andrews<td>�</td>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<td>�</td>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<td>
596912ee9ca8eb14d30707ec286ab5d28bd39b3eMark Andrews<var class="pdparam">filename</var><code>)</code>;</td>
8319af16557b81eba3277ee67215285f0823b587Mark Andrews</tr>
8319af16557b81eba3277ee67215285f0823b587Mark Andrews</table>
aee5e9cbacd8f88325840b8a498876f4319b0890Mark Andrews<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
9e5854255178c04170bc98839282d4cf3fae7443Mark Andrews<tr>
9e5854255178c04170bc98839282d4cf3fae7443Mark Andrews<td><code class="funcdef">
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrencelwres_result_t
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<b class="fsfunc">lwres_conf_print</b>(</code></td>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<td>�</td>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<td>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<var class="pdparam">ctx</var>, </td>
c32b87bc54abacf95fb3b063d72b7d1855c1643bMichael Graff</tr>
7f9f8c13c5e5e26e0ba2b82c0900d11ecf6269ceMark Andrews<tr>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<td>�</td>
c3e6fbe4b7471d843d015e3f1737b7edb9d0c547Mark Andrews<td>�</td>
c3e6fbe4b7471d843d015e3f1737b7edb9d0c547Mark Andrews<td>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<var class="pdparam">ctx</var>, </td>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence</tr>
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<tr>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<td>�</td>
a04588e781b513ae3b30e061ac98035802b5e8e8Mark Andrews<td>�</td>
5e47b4200ed81b8e18e165fe3a626d9992003db4Mark Andrews<td>
5e47b4200ed81b8e18e165fe3a626d9992003db4Mark Andrews<var class="pdparam">fp</var><code>)</code>;</td>
5e47b4200ed81b8e18e165fe3a626d9992003db4Mark Andrews</tr>
5e47b4200ed81b8e18e165fe3a626d9992003db4Mark Andrews</table>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
2320f230995995595438a9d9301d84931fd266ceMark Andrews<tr>
c427260a8678f2e99a2337fb95ec98d9c9ee8c05Mark Andrews<td><code class="funcdef">
620a452ebe92fff63e85c5930a6e6dc8d9455918Mark Andrewslwres_conf_t *
620a452ebe92fff63e85c5930a6e6dc8d9455918Mark Andrews<b class="fsfunc">lwres_conf_get</b>(</code></td>
6dcb47e37f9f0cdb94bdabc3fa157ff07983c590Mark Andrews<td>�</td>
6dcb47e37f9f0cdb94bdabc3fa157ff07983c590Mark Andrews<td>
43b3337ba58d70ca34f4d91e8c6c5e13a54af690Mark Andrews<var class="pdparam">ctx</var><code>)</code>;</td>
43b3337ba58d70ca34f4d91e8c6c5e13a54af690Mark Andrews</tr>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<tr>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<td>�</td>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<td>�</td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<td>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<var class="pdparam">ctx</var><code>)</code>;</td>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley</tr>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley</table>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley</div>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley</div>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<div class="refsect1" lang="en">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<a name="id2549498"></a><h2>DESCRIPTION</h2>
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence<p><code class="function">lwres_conf_init()</code>
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence creates an empty
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence <span class="type">lwres_conf_t</span>
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence structure for lightweight resolver context
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence <em class="parameter"><code>ctx</code></em>.
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence </p>
a9558a6c63d9c6dbb2f3800b39ccb008652fcde3Mark Andrews<p><code class="function">lwres_conf_clear()</code>
a9558a6c63d9c6dbb2f3800b39ccb008652fcde3Mark Andrews frees up all the internal memory used by
a9558a6c63d9c6dbb2f3800b39ccb008652fcde3Mark Andrews that
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <span class="type">lwres_conf_t</span>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews structure in resolver context
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence <em class="parameter"><code>ctx</code></em>.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt </p>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<p><code class="function">lwres_conf_parse()</code>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt opens the file
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <em class="parameter"><code>filename</code></em>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley and parses it to initialise the resolver context
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <em class="parameter"><code>ctx</code></em>'s
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <span class="type">lwres_conf_t</span>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley structure.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt </p>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<p><code class="function">lwres_conf_print()</code>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley prints the
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <span class="type">lwres_conf_t</span>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt structure for resolver context
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <em class="parameter"><code>ctx</code></em>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley to the
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <span class="type">FILE</span>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt <em class="parameter"><code>fp</code></em>.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley </p>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt</div>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<div class="refsect1" lang="en">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<a name="id2549565"></a><h2>RETURN VALUES</h2>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<p><code class="function">lwres_conf_parse()</code>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley returns <span class="errorcode">LWRES_R_SUCCESS</span>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt if it successfully read and parsed
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <em class="parameter"><code>filename</code></em>.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley It returns <span class="errorcode">LWRES_R_FAILURE</span>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley if <em class="parameter"><code>filename</code></em>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley could not be opened or contained incorrect
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley resolver statements.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt </p>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<p><code class="function">lwres_conf_print()</code>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley returns <span class="errorcode">LWRES_R_SUCCESS</span>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley unless an error occurred when converting the network addresses to a
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt numeric host address string.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt If this happens, the function returns
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt <span class="errorcode">LWRES_R_FAILURE</span>.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt </p>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley</div>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<div class="refsect1" lang="en">
<a name="id2549603"></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="id2549628"></a><h2>FILES</h2>
<p><code class="filename">/etc/resolv.conf</code>
</p>
</div>
</div></body>
</html>