lib/liblwres/man/lwres_config.html

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