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.9 2005/10/13 02:33:55 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.69.1">
  23 </head>
  24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  25 <a name="id2463721"></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"><tr>
  35 <td><code class="funcdef">
  36 void
  37 <b class="fsfunc">lwres_conf_init</b>(</code></td>
  38 <td> </td>
  39 <td>
  40 <code>)</code>;</td>
  41 </tr></table>
  42 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
  43 <td><code class="funcdef">
  44 void
  45 <b class="fsfunc">lwres_conf_clear</b>(</code></td>
  46 <td> </td>
  47 <td>
  48 <code>)</code>;</td>
  49 </tr></table>
  50 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
  51 <tr>
  52 <td><code class="funcdef">
  53 lwres_result_t
  54 <b class="fsfunc">lwres_conf_parse</b>(</code></td>
  55 <td> </td>
  56 <td>, </td>
  57 </tr>
  58 <tr>
  59 <td> </td>
  60 <td> </td>
  61 <td>
  62 <code>)</code>;</td>
  63 </tr>
  64 </table>
  65 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
  66 <tr>
  67 <td><code class="funcdef">
  68 lwres_result_t
  69 <b class="fsfunc">lwres_conf_print</b>(</code></td>
  70 <td> </td>
  71 <td>, </td>
  72 </tr>
  73 <tr>
  74 <td> </td>
  75 <td> </td>
  76 <td>
  77 <code>)</code>;</td>
  78 </tr>
  79 </table>
  80 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
  81 <td><code class="funcdef">
  82 lwres_conf_t *
  83 <b class="fsfunc">lwres_conf_get</b>(</code></td>
  84 <td> </td>
  85 <td>
  86 <code>)</code>;</td>
  87 </tr></table>
  88 </div>
  89 </div>
  90 <div class="refsect1" lang="en">
  91 <a name="id2525910"></a><h2>DESCRIPTION</h2>
  92 <p>
  93 <code class="function">lwres_conf_init()</code>
  94 creates an empty
  95 <span class="type">lwres_conf_t</span>
  96 structure for lightweight resolver context
  97 <em class="parameter"><code>ctx</code></em>.
  98 </p>
  99 <p>
 100 <code class="function">lwres_conf_clear()</code>
 101 frees up all the internal memory used by
 102 that
 103 <span class="type">lwres_conf_t</span>
 104 structure in resolver context
 105 <em class="parameter"><code>ctx</code></em>.
 106 </p>
 107 <p>
 108 <code class="function">lwres_conf_parse()</code>
 109 opens the file
 110 <em class="parameter"><code>filename</code></em>
 111 and parses it to initialise the resolver context
 112 <em class="parameter"><code>ctx</code></em>'s
 113 <span class="type">lwres_conf_t</span>
 114 structure.
 115 </p>
 116 <p>
 117 <code class="function">lwres_conf_print()</code>
 118 prints the
 119 <span class="type">lwres_conf_t</span>
 120 structure for resolver context
 121 <em class="parameter"><code>ctx</code></em>
 122 to the
 123 <span class="type">FILE</span>
 124 <em class="parameter"><code>fp</code></em>.
 125 </p>
 126 </div>
 127 <div class="refsect1" lang="en">
 128 <a name="id2525981"></a><h2>RETURN VALUES</h2>
 129 <p>
 130 <code class="function">lwres_conf_parse()</code>
 131 returns
 132 <span class="errorcode">LWRES_R_SUCCESS</span>
 133 if it successfully read and parsed
 134 <em class="parameter"><code>filename</code></em>.
 135 It returns
 136 <span class="errorcode">LWRES_R_FAILURE</span>
 137 if
 138 <em class="parameter"><code>filename</code></em>
 139 could not be opened or contained incorrect
 140 resolver statements.
 141 </p>
 142 <p>
 143 <code class="function">lwres_conf_print()</code>
 144 returns
 145 <span class="errorcode">LWRES_R_SUCCESS</span>
 146 unless an error occurred when converting the network addresses to a
 147 numeric host address string.
 148 If this happens, the function returns
 149 <span class="errorcode">LWRES_R_FAILURE</span>.
 150 </p>
 151 </div>
 152 <div class="refsect1" lang="en">
 153 <a name="id2526021"></a><h2>SEE ALSO</h2>
 154 <p>
 155 <span class="citerefentry"><span class="refentrytitle">stdio</span>(3)</span>,
 156 <span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>.
 157 </p>
 158 </div>
 159 <div class="refsect1" lang="en">
 160 <a name="id2526048"></a><h2>FILES</h2>
 161 <p>
 162 <code class="filename">/etc/resolv.conf</code>
 163 </p>
 164 </div>
 165 </div></body>
 166 </html>