diff options
Diffstat (limited to 'lib/liblwres/man/lwres_config.html')
| -rw-r--r-- | lib/liblwres/man/lwres_config.html | 295 |
1 files changed, 295 insertions, 0 deletions
diff --git a/lib/liblwres/man/lwres_config.html b/lib/liblwres/man/lwres_config.html new file mode 100644 index 000000000..67fbcdd88 --- /dev/null +++ b/lib/liblwres/man/lwres_config.html @@ -0,0 +1,295 @@ +<!-- + - Copyright (C) 2000, 2001 Internet Software Consortium. + - + - Permission to use, copy, modify, and distribute this software for any + - purpose with or without fee is hereby granted, provided that the above + - copyright notice and this permission notice appear in all copies. + - + - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM + - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL + - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL + - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, + - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING + - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, + - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION + - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +--> +<HTML +><HEAD +><TITLE +>lwres_config</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.61 +"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><H1 +><A +NAME="AEN1" +>lwres_config</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN8" +></A +><H2 +>Name</H2 +>lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get -- lightweight resolver configuration</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN15" +></A +><H2 +>Synopsis</H2 +><DIV +CLASS="FUNCSYNOPSIS" +><A +NAME="AEN16" +></A +><P +></P +><PRE +CLASS="FUNCSYNOPSISINFO" +>#include <lwres/lwres.h></PRE +><P +><CODE +><CODE +CLASS="FUNCDEF" +>void +lwres_conf_init</CODE +>(lwres_context_t *ctx);</CODE +></P +><P +><CODE +><CODE +CLASS="FUNCDEF" +>void +lwres_conf_clear</CODE +>(lwres_context_t *ctx);</CODE +></P +><P +><CODE +><CODE +CLASS="FUNCDEF" +>lwres_result_t +lwres_conf_parse</CODE +>(lwres_context_t *ctx, const char *filename);</CODE +></P +><P +><CODE +><CODE +CLASS="FUNCDEF" +>lwres_result_t +lwres_conf_print</CODE +>(lwres_context_t *ctx, FILE *fp);</CODE +></P +><P +><CODE +><CODE +CLASS="FUNCDEF" +>lwres_conf_t * +lwres_conf_get</CODE +>(lwres_context_t *ctx);</CODE +></P +><P +></P +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN40" +></A +><H2 +>DESCRIPTION</H2 +><P +><TT +CLASS="FUNCTION" +>lwres_conf_init()</TT +> +creates an empty +<SPAN +CLASS="TYPE" +>lwres_conf_t</SPAN +> +structure for lightweight resolver context +<TT +CLASS="PARAMETER" +><I +>ctx</I +></TT +>.</P +><P +><TT +CLASS="FUNCTION" +>lwres_conf_clear()</TT +> +frees up all the internal memory used by +that +<SPAN +CLASS="TYPE" +>lwres_conf_t</SPAN +> +structure in resolver context +<TT +CLASS="PARAMETER" +><I +>ctx</I +></TT +>.</P +><P +><TT +CLASS="FUNCTION" +>lwres_conf_parse()</TT +> +opens the file +<TT +CLASS="PARAMETER" +><I +>filename</I +></TT +> +and parses it to initialise the resolver context +<TT +CLASS="PARAMETER" +><I +>ctx</I +></TT +>'s +<SPAN +CLASS="TYPE" +>lwres_conf_t</SPAN +> +structure.</P +><P +><TT +CLASS="FUNCTION" +>lwres_conf_print()</TT +> +prints the +<SPAN +CLASS="TYPE" +>lwres_conf_t</SPAN +> +structure for resolver context +<TT +CLASS="PARAMETER" +><I +>ctx</I +></TT +> +to the +<SPAN +CLASS="TYPE" +>FILE</SPAN +> +<TT +CLASS="PARAMETER" +><I +>fp</I +></TT +>.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN61" +></A +><H2 +>RETURN VALUES</H2 +><P +><TT +CLASS="FUNCTION" +>lwres_conf_parse()</TT +> +returns +<SPAN +CLASS="ERRORCODE" +>LWRES_R_SUCCESS</SPAN +> +if it successfully read and parsed +<TT +CLASS="PARAMETER" +><I +>filename</I +></TT +>. +It returns +<SPAN +CLASS="ERRORCODE" +>LWRES_R_FAILURE</SPAN +> +if +<TT +CLASS="PARAMETER" +><I +>filename</I +></TT +> +could not be opened or contained incorrect +resolver statements.</P +><P +><TT +CLASS="FUNCTION" +>lwres_conf_print()</TT +> +returns +<SPAN +CLASS="ERRORCODE" +>LWRES_R_SUCCESS</SPAN +> +unless an error occurred when converting the network addresses to a +numeric host address string. +If this happens, the function returns +<SPAN +CLASS="ERRORCODE" +>LWRES_R_FAILURE</SPAN +>.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN73" +></A +><H2 +>SEE ALSO</H2 +><P +><SPAN +CLASS="CITEREFENTRY" +><SPAN +CLASS="REFENTRYTITLE" +>stdio</SPAN +>(3)</SPAN +>, +<SPAN +CLASS="CITEREFENTRY" +><SPAN +CLASS="REFENTRYTITLE" +>resolver</SPAN +>(5)</SPAN +>.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN82" +></A +><H2 +>FILES</H2 +><P +><TT +CLASS="FILENAME" +>/etc/resolv.conf</TT +></P +></DIV +></BODY +></HTML +>
\ No newline at end of file |