external/bsd/bind/dist/lib/lwres/man/lwres_getrrsetbyname.3

   1 .\"     $NetBSD: lwres_getrrsetbyname.3,v 1.5 2014/12/10 04:38:02 christos Exp $
   2 .\"
   3 .\" Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
   4 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
   5 .\"
   6 .\" Permission to use, copy, modify, and/or distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  11 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  12 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  13 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  14 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  15 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16 .\" PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .\" Id
  19 .\"
  20 .hy 0
  21 .ad l
  22 .\"     Title: lwres_getrrsetbyname
  23 .\"    Author:
  24 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  25 .\"      Date: June 18, 2007
  26 .\"    Manual: BIND9
  27 .\"    Source: BIND9
  28 .\"
  29 .TH "LWRES_GETRRSETBYNAME" "3" "June 18, 2007" "BIND9" "BIND9"
  30 .\" disable hyphenation
  31 .nh
  32 .\" disable justification (adjust text to left margin only)
  33 .ad l
  34 .SH "NAME"
  35 lwres_getrrsetbyname, lwres_freerrset \- retrieve DNS records
  36 .SH "SYNOPSIS"
  37 .nf
  38 #include <lwres/netdb.h>
  39 .fi
  40 .HP 25
  41 .BI "int lwres_getrrsetbyname(const\ char\ *" "hostname" ", unsigned\ int\ " "rdclass" ", unsigned\ int\ " "rdtype" ", unsigned\ int\ " "flags" ", struct\ rrsetinfo\ **" "res" ");"
  42 .HP 21
  43 .BI "void lwres_freerrset(struct\ rrsetinfo\ *" "rrset" ");"
  44 .PP
  45 The following structures are used:
  46 .PP
  47 .RS 4
  48 .nf
  49 struct  rdatainfo {
  50         unsigned int            rdi_length;     /* length of data */
  51         unsigned char           *rdi_data;      /* record data */
  52 };
  53 .fi
  54 .RE
  55 .sp
  56 .PP
  57 .RS 4
  58 .nf
  59 struct  rrsetinfo {
  60         unsigned int            rri_flags;      /* RRSET_VALIDATED... */
  61         unsigned int            rri_rdclass;    /* class number */
  62         unsigned int            rri_rdtype;     /* RR type number */
  63         unsigned int            rri_ttl;        /* time to live */
  64         unsigned int            rri_nrdatas;    /* size of rdatas array */
  65         unsigned int            rri_nsigs;      /* size of sigs array */
  66         char                    *rri_name;      /* canonical name */
  67         struct rdatainfo        *rri_rdatas;    /* individual records */
  68         struct rdatainfo        *rri_sigs;      /* individual signatures */
  69 };
  70 .fi
  71 .RE
  72 .sp
  73 .SH "DESCRIPTION"
  74 .PP
  75 \fBlwres_getrrsetbyname()\fR
  76 gets a set of resource records associated with a
  77 \fIhostname\fR,
  78 \fIclass\fR, and
  79 \fItype\fR.
  80 \fIhostname\fR
  81 is a pointer a to null\-terminated string. The
  82 \fIflags\fR
  83 field is currently unused and must be zero.
  84 .PP
  85 After a successful call to
  86 \fBlwres_getrrsetbyname()\fR,
  87 \fI*res\fR
  88 is a pointer to an
  89 \fBrrsetinfo\fR
  90 structure, containing a list of one or more
  91 \fBrdatainfo\fR
  92 structures containing resource records and potentially another list of
  93 \fBrdatainfo\fR
  94 structures containing SIG resource records associated with those records. The members
  95 \fBrri_rdclass\fR
  96 and
  97 \fBrri_rdtype\fR
  98 are copied from the parameters.
  99 \fBrri_ttl\fR
 100 and
 101 \fBrri_name\fR
 102 are properties of the obtained rrset. The resource records contained in
 103 \fBrri_rdatas\fR
 104 and
 105 \fBrri_sigs\fR
 106 are in uncompressed DNS wire format. Properties of the rdataset are represented in the
 107 \fBrri_flags\fR
 108 bitfield. If the RRSET_VALIDATED bit is set, the data has been DNSSEC validated and the signatures verified.
 109 .PP
 110 All of the information returned by
 111 \fBlwres_getrrsetbyname()\fR
 112 is dynamically allocated: the
 113 \fBrrsetinfo\fR
 114 and
 115 \fBrdatainfo\fR
 116 structures, and the canonical host name strings pointed to by the
 117 \fBrrsetinfo\fRstructure. Memory allocated for the dynamically allocated structures created by a successful call to
 118 \fBlwres_getrrsetbyname()\fR
 119 is released by
 120 \fBlwres_freerrset()\fR.
 121 \fIrrset\fR
 122 is a pointer to a
 123 \fBstruct rrset\fR
 124 created by a call to
 125 \fBlwres_getrrsetbyname()\fR.
 126 .PP
 127 .SH "RETURN VALUES"
 128 .PP
 129 \fBlwres_getrrsetbyname()\fR
 130 returns zero on success, and one of the following error codes if an error occurred:
 131 .PP
 132 \fBERRSET_NONAME\fR
 133 .RS 4
 134 the name does not exist
 135 .RE
 136 .PP
 137 \fBERRSET_NODATA\fR
 138 .RS 4
 139 the name exists, but does not have data of the desired type
 140 .RE
 141 .PP
 142 \fBERRSET_NOMEMORY\fR
 143 .RS 4
 144 memory could not be allocated
 145 .RE
 146 .PP
 147 \fBERRSET_INVAL\fR
 148 .RS 4
 149 a parameter is invalid
 150 .RE
 151 .PP
 152 \fBERRSET_FAIL\fR
 153 .RS 4
 154 other failure
 155 .RE
 156 .PP
 157 .RS 4
 158 .RE
 159 .SH "SEE ALSO"
 160 .PP
 161 \fBlwres\fR(3).
 162 .SH "COPYRIGHT"
 163 Copyright \(co 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
 164 .br
 165 Copyright \(co 2000, 2001 Internet Software Consortium.
 166 .br