lwres_config.3   [plain text]


.\"
.\" 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.
.\"
.TH "LWRES_CONFIG" "3" "Jun 30, 2000" "BIND9" ""
.SH NAME
lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get \- lightweight resolver configuration
.SH SYNOPSIS
\fB#include <lwres/lwres.h>
.sp
.na
void
lwres_conf_init(lwres_context_t *ctx);
.ad
.sp
.na
void
lwres_conf_clear(lwres_context_t *ctx);
.ad
.sp
.na
lwres_result_t
lwres_conf_parse(lwres_context_t *ctx, const char *filename);
.ad
.sp
.na
lwres_result_t
lwres_conf_print(lwres_context_t *ctx, FILE *fp);
.ad
.sp
.na
lwres_conf_t *
lwres_conf_get(lwres_context_t *ctx);
.ad
\fR
.SH "DESCRIPTION"
.PP
\fBlwres_conf_init()\fR
creates an empty
\fBlwres_conf_t\fR
structure for lightweight resolver context
\fIctx\fR.
.PP
\fBlwres_conf_clear()\fR
frees up all the internal memory used by
that
\fBlwres_conf_t\fR
structure in resolver context
\fIctx\fR.
.PP
\fBlwres_conf_parse()\fR
opens the file
\fIfilename\fR
and parses it to initialise the resolver context
\fIctx\fR's
\fBlwres_conf_t\fR
structure.
.PP
\fBlwres_conf_print()\fR
prints the
\fBlwres_conf_t\fR
structure for resolver context
\fIctx\fR
to the
\fBFILE\fR
\fIfp\fR.
.SH "RETURN VALUES"
.PP
\fBlwres_conf_parse()\fR
returns
LWRES_R_SUCCESS
if it successfully read and parsed
\fIfilename\fR.
It returns
LWRES_R_FAILURE
if
\fIfilename\fR
could not be opened or contained incorrect
resolver statements.
.PP
\fBlwres_conf_print()\fR
returns
LWRES_R_SUCCESS
unless an error occurred when converting the network addresses to a
numeric host address string.
If this happens, the function returns
LWRES_R_FAILURE.
.SH "SEE ALSO"
.PP
\fBstdio\fR(3),
\fBresolver\fR(5).
.SH "FILES"
.PP
\fI/etc/resolv.conf\fR