Merge branch 'vendor/TCSH'
[dragonfly.git] / contrib / bind-9.3 / lib / lwres / man / lwres_config.html
1 <!--
2  - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
3  - Copyright (C) 2000, 2001 Internet Software Consortium.
4  - 
5  - Permission to use, copy, modify, and distribute this software for any
6  - purpose with or without fee is hereby granted, provided that the above
7  - copyright notice and this permission notice appear in all copies.
8  - 
9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15  - PERFORMANCE OF THIS SOFTWARE.
16 -->
17 <!-- $Id: lwres_config.html,v 1.4.2.1.4.11 2006/06/29 13:02:31 marka Exp $ -->
18 <html>
19 <head>
20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21 <title>lwres_config</title>
22 <meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
23 </head>
24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
25 <a name="id2482688"></a><div class="titlepage"></div>
26 <div class="refnamediv">
27 <h2>Name</h2>
28 <p>lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get &#8212; lightweight resolver configuration</p>
29 </div>
30 <div class="refsynopsisdiv">
31 <h2>Synopsis</h2>
32 <div class="funcsynopsis">
33 <pre class="funcsynopsisinfo">#include &lt;lwres/lwres.h&gt;</pre>
34 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
35 <tr>
36 <td><code class="funcdef">
37 void
38 <b class="fsfunc">lwres_conf_init</b>(</code></td>
39 <td> </td>
40 <td>
41 <code>)</code>;</td>
42 </tr>
43 <tr>
44 <td> </td>
45 <td> </td>
46 <td>
47 <code>)</code>;</td>
48 </tr>
49 </table>
50 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
51 <tr>
52 <td><code class="funcdef">
53 void
54 <b class="fsfunc">lwres_conf_clear</b>(</code></td>
55 <td> </td>
56 <td>
57 <code>)</code>;</td>
58 </tr>
59 <tr>
60 <td> </td>
61 <td> </td>
62 <td>
63 <code>)</code>;</td>
64 </tr>
65 </table>
66 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
67 <tr>
68 <td><code class="funcdef">
69 lwres_result_t
70 <b class="fsfunc">lwres_conf_parse</b>(</code></td>
71 <td> </td>
72 <td>, </td>
73 </tr>
74 <tr>
75 <td> </td>
76 <td> </td>
77 <td>, </td>
78 </tr>
79 <tr>
80 <td> </td>
81 <td> </td>
82 <td>
83 <code>)</code>;</td>
84 </tr>
85 </table>
86 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
87 <tr>
88 <td><code class="funcdef">
89 lwres_result_t
90 <b class="fsfunc">lwres_conf_print</b>(</code></td>
91 <td> </td>
92 <td>, </td>
93 </tr>
94 <tr>
95 <td> </td>
96 <td> </td>
97 <td>, </td>
98 </tr>
99 <tr>
100 <td> </td>
101 <td> </td>
102 <td>
103 <code>)</code>;</td>
104 </tr>
105 </table>
106 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
107 <tr>
108 <td><code class="funcdef">
109 lwres_conf_t *
110 <b class="fsfunc">lwres_conf_get</b>(</code></td>
111 <td> </td>
112 <td>
113 <code>)</code>;</td>
114 </tr>
115 <tr>
116 <td> </td>
117 <td> </td>
118 <td>
119 <code>)</code>;</td>
120 </tr>
121 </table>
122 </div>
123 </div>
124 <div class="refsect1" lang="en">
125 <a name="id2549475"></a><h2>DESCRIPTION</h2>
126 <p>
127 <code class="function">lwres_conf_init()</code>
128 creates an empty
129 <span class="type">lwres_conf_t</span>
130 structure for lightweight resolver context
131 <em class="parameter"><code>ctx</code></em>.
132 </p>
133 <p>
134 <code class="function">lwres_conf_clear()</code>
135 frees up all the internal memory used by
136 that
137 <span class="type">lwres_conf_t</span>
138 structure in resolver context
139 <em class="parameter"><code>ctx</code></em>.
140 </p>
141 <p>
142 <code class="function">lwres_conf_parse()</code>
143 opens the file
144 <em class="parameter"><code>filename</code></em>
145 and parses it to initialise the resolver context
146 <em class="parameter"><code>ctx</code></em>'s
147 <span class="type">lwres_conf_t</span>
148 structure.
149 </p>
150 <p>
151 <code class="function">lwres_conf_print()</code>
152 prints the
153 <span class="type">lwres_conf_t</span>
154 structure for resolver context
155 <em class="parameter"><code>ctx</code></em>
156 to the
157 <span class="type">FILE</span>
158 <em class="parameter"><code>fp</code></em>.
159 </p>
160 </div>
161 <div class="refsect1" lang="en">
162 <a name="id2549546"></a><h2>RETURN VALUES</h2>
163 <p>
164 <code class="function">lwres_conf_parse()</code>
165 returns
166 <span class="errorcode">LWRES_R_SUCCESS</span>
167 if it successfully read and parsed
168 <em class="parameter"><code>filename</code></em>.
169 It returns
170 <span class="errorcode">LWRES_R_FAILURE</span>
171 if
172 <em class="parameter"><code>filename</code></em>
173 could not be opened or contained incorrect
174 resolver statements.
175 </p>
176 <p>
177 <code class="function">lwres_conf_print()</code>
178 returns
179 <span class="errorcode">LWRES_R_SUCCESS</span>
180 unless an error occurred when converting the network addresses to a
181 numeric host address string.
182 If this happens, the function returns
183 <span class="errorcode">LWRES_R_FAILURE</span>.
184 </p>
185 </div>
186 <div class="refsect1" lang="en">
187 <a name="id2549586"></a><h2>SEE ALSO</h2>
188 <p>
189 <span class="citerefentry"><span class="refentrytitle">stdio</span>(3)</span>,
190 <span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>.
191 </p>
192 </div>
193 <div class="refsect1" lang="en">
194 <a name="id2549612"></a><h2>FILES</h2>
195 <p>
196 <code class="filename">/etc/resolv.conf</code>
197 </p>
198 </div>
199 </div></body>
200 </html>