/contrib/bind9/lib/lwres/man/lwres_config.html

https://bitbucket.org/freebsd/freebsd-head/ · HTML · 156 lines · 139 code · 0 blank · 17 comment · 0 complexity · 6d39d0bdfc7419a98d799b022bc2902f MD5 · raw file 

    

  1. <!--
    2. 

  2.  - Copyright (C) 2004, 2005, 2007, 2012 Internet Systems Consortium, Inc. ("ISC")
    3. 

  3.  - Copyright (C) 2000, 2001 Internet Software Consortium.
    4. 

  4.  - 
    5. 

  5.  - Permission to use, copy, modify, and/or distribute this software for any
    6. 

  6.  - purpose with or without fee is hereby granted, provided that the above
    7. 

  7.  - copyright notice and this permission notice appear in all copies.
    8. 

  8.  - 
    9. 

  9.  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
    10. 

  10.  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
    11. 

  11.  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
    12. 

  12.  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
    13. 

  13.  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
    14. 

  14.  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
    15. 

  15.  - PERFORMANCE OF THIS SOFTWARE.
    16. 

  16. -->
    17. 

  17. <!-- $Id$ -->
    18. 

  18. <html>
    19. 

  19. <head>
    20. 

  20. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
    21. 

  21. <title>lwres_config</title>
    22. 

  22. <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
    23. 

  23. </head>
    24. 

  24. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
    25. 

  25. <a name="id2476275"></a><div class="titlepage"></div>
    26. 

  26. <div class="refnamediv">
    27. 

  27. <h2>Name</h2>
    28. 

  28. <p>lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get &#8212; lightweight resolver configuration</p>
    29. 

  29. </div>
    30. 

  30. <div class="refsynopsisdiv">
    31. 

  31. <h2>Synopsis</h2>
    32. 

  32. <div class="funcsynopsis">
    33. 

  33. <pre class="funcsynopsisinfo">#include &lt;lwres/lwres.h&gt;</pre>
    34. 

  34. <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
    35. 

  35. <td><code class="funcdef">
    36. 

  36. void
    37. 

  37. <b class="fsfunc">lwres_conf_init</b>(</code></td>
    38. 

  38. <td>lwres_context_t * </td>
    39. 

  39. <td>
    40. 

  40. <var class="pdparam">ctx</var><code>)</code>;</td>
    41. 

  41. </tr></table>
    42. 

  42. <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
    43. 

  43. <td><code class="funcdef">
    44. 

  44. void
    45. 

  45. <b class="fsfunc">lwres_conf_clear</b>(</code></td>
    46. 

  46. <td>lwres_context_t * </td>
    47. 

  47. <td>
    48. 

  48. <var class="pdparam">ctx</var><code>)</code>;</td>
    49. 

  49. </tr></table>
    50. 

  50. <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
    51. 

  51. <tr>
    52. 

  52. <td><code class="funcdef">
    53. 

  53. lwres_result_t
    54. 

  54. <b class="fsfunc">lwres_conf_parse</b>(</code></td>
    55. 

  55. <td>lwres_context_t * </td>
    56. 

  56. <td>
    57. 

  57. <var class="pdparam">ctx</var>, </td>
    58. 

  58. </tr>
    59. 

  59. <tr>
    60. 

  60. <td> </td>
    61. 

  61. <td>const char * </td>
    62. 

  62. <td>
    63. 

  63. <var class="pdparam">filename</var><code>)</code>;</td>
    64. 

  64. </tr>
    65. 

  65. </table>
    66. 

  66. <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
    67. 

  67. <tr>
    68. 

  68. <td><code class="funcdef">
    69. 

  69. lwres_result_t
    70. 

  70. <b class="fsfunc">lwres_conf_print</b>(</code></td>
    71. 

  71. <td>lwres_context_t * </td>
    72. 

  72. <td>
    73. 

  73. <var class="pdparam">ctx</var>, </td>
    74. 

  74. </tr>
    75. 

  75. <tr>
    76. 

  76. <td> </td>
    77. 

  77. <td>FILE * </td>
    78. 

  78. <td>
    79. 

  79. <var class="pdparam">fp</var><code>)</code>;</td>
    80. 

  80. </tr>
    81. 

  81. </table>
    82. 

  82. <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
    83. 

  83. <td><code class="funcdef">
    84. 

  84. lwres_conf_t *
    85. 

  85. <b class="fsfunc">lwres_conf_get</b>(</code></td>
    86. 

  86. <td>lwres_context_t * </td>
    87. 

  87. <td>
    88. 

  88. <var class="pdparam">ctx</var><code>)</code>;</td>
    89. 

  89. </tr></table>
    90. 

  90. </div>
    91. 

  91. </div>
    92. 

  92. <div class="refsect1" lang="en">
    93. 

  93. <a name="id2543445"></a><h2>DESCRIPTION</h2>
    94. 

  94. <p><code class="function">lwres_conf_init()</code>
    95. 

  95.       creates an empty
    96. 

  96.       <span class="type">lwres_conf_t</span>
    97. 

  97.       structure for lightweight resolver context
    98. 

  98.       <em class="parameter"><code>ctx</code></em>.
    99. 

  99.     </p>
    100. 

  100. <p><code class="function">lwres_conf_clear()</code>
    101. 

  101.       frees up all the internal memory used by
    102. 

  102.       that
    103. 

  103.       <span class="type">lwres_conf_t</span>
    104. 

  104.       structure in resolver context
    105. 

  105.       <em class="parameter"><code>ctx</code></em>.
    106. 

  106.     </p>
    107. 

  107. <p><code class="function">lwres_conf_parse()</code>
    108. 

  108.       opens the file
    109. 

  109.       <em class="parameter"><code>filename</code></em>
    110. 

  110.       and parses it to initialise the resolver context
    111. 

  111.       <em class="parameter"><code>ctx</code></em>'s
    112. 

  112.       <span class="type">lwres_conf_t</span>
    113. 

  113.       structure.
    114. 

  114.     </p>
    115. 

  115. <p><code class="function">lwres_conf_print()</code>
    116. 

  116.       prints the
    117. 

  117.       <span class="type">lwres_conf_t</span>
    118. 

  118.       structure for resolver context
    119. 

  119.       <em class="parameter"><code>ctx</code></em>
    120. 

  120.       to the
    121. 

  121.       <span class="type">FILE</span>
    122. 

  122.       <em class="parameter"><code>fp</code></em>.
    123. 

  123.     </p>
    124. 

  124. </div>
    125. 

  125. <div class="refsect1" lang="en">
    126. 

  126. <a name="id2543512"></a><h2>RETURN VALUES</h2>
    127. 

  127. <p><code class="function">lwres_conf_parse()</code>
    128. 

  128.       returns <span class="errorcode">LWRES_R_SUCCESS</span>
    129. 

  129.       if it successfully read and parsed
    130. 

  130.       <em class="parameter"><code>filename</code></em>.
    131. 

  131.       It returns <span class="errorcode">LWRES_R_FAILURE</span>
    132. 

  132.       if <em class="parameter"><code>filename</code></em>
    133. 

  133.       could not be opened or contained incorrect
    134. 

  134.       resolver statements.
    135. 

  135.     </p>
    136. 

  136. <p><code class="function">lwres_conf_print()</code>
    137. 

  137.       returns <span class="errorcode">LWRES_R_SUCCESS</span>
    138. 

  138.       unless an error occurred when converting the network addresses to a
    139. 

  139.       numeric host address string.
    140. 

  140.       If this happens, the function returns
    141. 

  141.       <span class="errorcode">LWRES_R_FAILURE</span>.
    142. 

  142.     </p>
    143. 

  143. </div>
    144. 

  144. <div class="refsect1" lang="en">
    145. 

  145. <a name="id2543549"></a><h2>SEE ALSO</h2>
    146. 

  146. <p><span class="citerefentry"><span class="refentrytitle">stdio</span>(3)</span>,
    147. 

  147.       <span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>.
    148. 

  148.     </p>
    149. 

  149. </div>
    150. 

  150. <div class="refsect1" lang="en">
    151. 

  151. <a name="id2543575"></a><h2>FILES</h2>
    152. 

  152. <p><code class="filename">/etc/resolv.conf</code>
    153. 

  153.     </p>
    154. 

  154. </div>
    155. 

  155. </div></body>
    156. 

  156. </html>
    157.