contrib/bind-9.2.4rc7/lib/lwres/man/lwres_config.html

   1 <!--
   2  - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 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
  18 <!-- $Id: lwres_config.html,v 1.4.2.2 2004/03/15 04:45:01 marka Exp $ -->
  19
  20 <HTML
  21 ><HEAD
  22 ><TITLE
  23 >lwres_config</TITLE
  24 ><META
  25 NAME="GENERATOR"
  26 CONTENT="Modular DocBook HTML Stylesheet Version 1.73
  27 "></HEAD
  28 ><BODY
  29 CLASS="REFENTRY"
  30 BGCOLOR="#FFFFFF"
  31 TEXT="#000000"
  32 LINK="#0000FF"
  33 VLINK="#840084"
  34 ALINK="#0000FF"
  35 ><H1
  36 ><A
  37 NAME="AEN1"
  38 >lwres_config</A
  39 ></H1
  40 ><DIV
  41 CLASS="REFNAMEDIV"
  42 ><A
  43 NAME="AEN8"
  44 ></A
  45 ><H2
  46 >Name</H2
  47 >lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get&nbsp;--&nbsp;lightweight resolver configuration</DIV
  48 ><DIV
  49 CLASS="REFSYNOPSISDIV"
  50 ><A
  51 NAME="AEN15"
  52 ></A
  53 ><H2
  54 >Synopsis</H2
  55 ><DIV
  56 CLASS="FUNCSYNOPSIS"
  57 ><A
  58 NAME="AEN16"
  59 ></A
  60 ><P
  61 ></P
  62 ><PRE
  63 CLASS="FUNCSYNOPSISINFO"
  64 >#include &lt;lwres/lwres.h&gt;</PRE
  65 ><P
  66 ><CODE
  67 ><CODE
  68 CLASS="FUNCDEF"
  69 >void
  70 lwres_conf_init</CODE
  71 >(lwres_context_t *ctx);</CODE
  72 ></P
  73 ><P
  74 ><CODE
  75 ><CODE
  76 CLASS="FUNCDEF"
  77 >void
  78 lwres_conf_clear</CODE
  79 >(lwres_context_t *ctx);</CODE
  80 ></P
  81 ><P
  82 ><CODE
  83 ><CODE
  84 CLASS="FUNCDEF"
  85 >lwres_result_t
  86 lwres_conf_parse</CODE
  87 >(lwres_context_t *ctx, const char *filename);</CODE
  88 ></P
  89 ><P
  90 ><CODE
  91 ><CODE
  92 CLASS="FUNCDEF"
  93 >lwres_result_t
  94 lwres_conf_print</CODE
  95 >(lwres_context_t *ctx, FILE *fp);</CODE
  96 ></P
  97 ><P
  98 ><CODE
  99 ><CODE
 100 CLASS="FUNCDEF"
 101 >lwres_conf_t *
 102 lwres_conf_get</CODE
 103 >(lwres_context_t *ctx);</CODE
 104 ></P
 105 ><P
 106 ></P
 107 ></DIV
 108 ></DIV
 109 ><DIV
 110 CLASS="REFSECT1"
 111 ><A
 112 NAME="AEN40"
 113 ></A
 114 ><H2
 115 >DESCRIPTION</H2
 116 ><P
 117 ><TT
 118 CLASS="FUNCTION"
 119 >lwres_conf_init()</TT
 120 >
 121 creates an empty
 122 <SPAN
 123 CLASS="TYPE"
 124 >lwres_conf_t</SPAN
 125 >
 126 structure for lightweight resolver context
 127 <TT
 128 CLASS="PARAMETER"
 129 ><I
 130 >ctx</I
 131 ></TT
 132 >.</P
 133 ><P
 134 ><TT
 135 CLASS="FUNCTION"
 136 >lwres_conf_clear()</TT
 137 >
 138 frees up all the internal memory used by
 139 that
 140 <SPAN
 141 CLASS="TYPE"
 142 >lwres_conf_t</SPAN
 143 >
 144 structure in resolver context
 145 <TT
 146 CLASS="PARAMETER"
 147 ><I
 148 >ctx</I
 149 ></TT
 150 >.</P
 151 ><P
 152 ><TT
 153 CLASS="FUNCTION"
 154 >lwres_conf_parse()</TT
 155 >
 156 opens the file
 157 <TT
 158 CLASS="PARAMETER"
 159 ><I
 160 >filename</I
 161 ></TT
 162 >
 163 and parses it to initialise the resolver context
 164 <TT
 165 CLASS="PARAMETER"
 166 ><I
 167 >ctx</I
 168 ></TT
 169 >'s
 170 <SPAN
 171 CLASS="TYPE"
 172 >lwres_conf_t</SPAN
 173 >
 174 structure.</P
 175 ><P
 176 ><TT
 177 CLASS="FUNCTION"
 178 >lwres_conf_print()</TT
 179 >
 180 prints the
 181 <SPAN
 182 CLASS="TYPE"
 183 >lwres_conf_t</SPAN
 184 >
 185 structure for resolver context
 186 <TT
 187 CLASS="PARAMETER"
 188 ><I
 189 >ctx</I
 190 ></TT
 191 >
 192 to the
 193 <SPAN
 194 CLASS="TYPE"
 195 >FILE</SPAN
 196 >
 197 <TT
 198 CLASS="PARAMETER"
 199 ><I
 200 >fp</I
 201 ></TT
 202 >.</P
 203 ></DIV
 204 ><DIV
 205 CLASS="REFSECT1"
 206 ><A
 207 NAME="AEN61"
 208 ></A
 209 ><H2
 210 >RETURN VALUES</H2
 211 ><P
 212 ><TT
 213 CLASS="FUNCTION"
 214 >lwres_conf_parse()</TT
 215 >
 216 returns
 217 <SPAN
 218 CLASS="ERRORCODE"
 219 >LWRES_R_SUCCESS</SPAN
 220 >
 221 if it successfully read and parsed
 222 <TT
 223 CLASS="PARAMETER"
 224 ><I
 225 >filename</I
 226 ></TT
 227 >.
 228 It returns
 229 <SPAN
 230 CLASS="ERRORCODE"
 231 >LWRES_R_FAILURE</SPAN
 232 >
 233 if
 234 <TT
 235 CLASS="PARAMETER"
 236 ><I
 237 >filename</I
 238 ></TT
 239 >
 240 could not be opened or contained incorrect
 241 resolver statements.</P
 242 ><P
 243 ><TT
 244 CLASS="FUNCTION"
 245 >lwres_conf_print()</TT
 246 >
 247 returns
 248 <SPAN
 249 CLASS="ERRORCODE"
 250 >LWRES_R_SUCCESS</SPAN
 251 >
 252 unless an error occurred when converting the network addresses to a
 253 numeric host address string.
 254 If this happens, the function returns
 255 <SPAN
 256 CLASS="ERRORCODE"
 257 >LWRES_R_FAILURE</SPAN
 258 >.</P
 259 ></DIV
 260 ><DIV
 261 CLASS="REFSECT1"
 262 ><A
 263 NAME="AEN73"
 264 ></A
 265 ><H2
 266 >SEE ALSO</H2
 267 ><P
 268 ><SPAN
 269 CLASS="CITEREFENTRY"
 270 ><SPAN
 271 CLASS="REFENTRYTITLE"
 272 >stdio</SPAN
 273 >(3)</SPAN
 274 >,
 275 <SPAN
 276 CLASS="CITEREFENTRY"
 277 ><SPAN
 278 CLASS="REFENTRYTITLE"
 279 >resolver</SPAN
 280 >(5)</SPAN
 281 >.</P
 282 ></DIV
 283 ><DIV
 284 CLASS="REFSECT1"
 285 ><A
 286 NAME="AEN82"
 287 ></A
 288 ><H2
 289 >FILES</H2
 290 ><P
 291 ><TT
 292 CLASS="FILENAME"
 293 >/etc/resolv.conf</TT
 294 ></P
 295 ></DIV
 296 ></BODY
 297 ></HTML
 298 >