lwres_getrrsetbyname.html revision 00380255bd1a9359fd3791ea33d5bee37af9e41a
4139N/A<!--
4139N/A - Copyright (C) 2000, 2001 Internet Software Consortium.
4139N/A -
4139N/A - Permission to use, copy, modify, and distribute this software for any
4139N/A - purpose with or without fee is hereby granted, provided that the above
4139N/A - copyright notice and this permission notice appear in all copies.
4139N/A -
4139N/A - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
4139N/A - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
4139N/A - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
4139N/A - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
4139N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
4139N/A - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
4139N/A - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
4139N/A - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
4139N/A-->
4139N/A<HTML
4139N/A><HEAD
4139N/A><TITLE
4139N/A>lwres_getrrsetbyname</TITLE
4139N/A><META
4139N/ANAME="GENERATOR"
4139N/ACONTENT="Modular DocBook HTML Stylesheet Version 1.61
4139N/A"></HEAD
4139N/A><BODY
4139N/ACLASS="REFENTRY"
4139N/ABGCOLOR="#FFFFFF"
4139N/ATEXT="#000000"
4139N/ALINK="#0000FF"
4139N/AVLINK="#840084"
4139N/AALINK="#0000FF"
4139N/A><H1
4139N/A><A
4139N/ANAME="AEN1"
4139N/A>lwres_getrrsetbyname</A
4139N/A></H1
4139N/A><DIV
4139N/ACLASS="REFNAMEDIV"
4139N/A><A
4139N/ANAME="AEN8"
4139N/A></A
4139N/A><H2
4139N/A>Name</H2
4139N/A>lwres_getrrsetbyname, lwres_freerrset&nbsp;--&nbsp;retrieve DNS records</DIV
4139N/A><DIV
4139N/ACLASS="REFSYNOPSISDIV"
4139N/A><A
4139N/ANAME="AEN12"
4139N/A></A
4139N/A><H2
4139N/A>Synopsis</H2
4139N/A><DIV
4139N/ACLASS="FUNCSYNOPSIS"
4139N/A><A
4139N/ANAME="AEN13"
4139N/A></A
4139N/A><P
4139N/A></P
4139N/A><PRE
4139N/ACLASS="FUNCSYNOPSISINFO"
4139N/A>#include &lt;lwres/netdb.h&gt;</PRE
4139N/A><P
4139N/A><CODE
4139N/A><CODE
4139N/ACLASS="FUNCDEF"
4139N/A>int
4139N/Alwres_getrrsetbyname</CODE
4139N/A>(const char *hostname, unsigned int rdclass, unsigned int rdtype, unsigned int flags, struct rrsetinfo **res);</CODE
4139N/A></P
4139N/A><P
4139N/A><CODE
4139N/A><CODE
4139N/ACLASS="FUNCDEF"
4139N/A>void
4139N/Alwres_freerrset</CODE
4139N/A>(struct rrsetinfo *rrset);</CODE
4139N/A></P
4139N/A><P
4139N/A></P
4139N/A></DIV
4139N/A><P
4139N/A>The following structures are used:
4139N/A<PRE
4139N/ACLASS="PROGRAMLISTING"
4139N/A>struct rdatainfo {
4139N/A unsigned int rdi_length; /* length of data */
4139N/A unsigned char *rdi_data; /* record data */
4139N/A};
4139N/A
4139N/Astruct rrsetinfo {
4139N/A unsigned int rri_flags; /* RRSET_VALIDATED... */
4139N/A unsigned int rri_rdclass; /* class number */
4139N/A unsigned int rri_rdtype; /* RR type number */
4139N/A unsigned int rri_ttl; /* time to live */
4139N/A unsigned int rri_nrdatas; /* size of rdatas array */
4139N/A unsigned int rri_nsigs; /* size of sigs array */
4139N/A char *rri_name; /* canonical name */
4139N/A struct rdatainfo *rri_rdatas; /* individual records */
4139N/A struct rdatainfo *rri_sigs; /* individual signatures */
4139N/A};</PRE
4139N/A></P
4139N/A></DIV
4139N/A><DIV
4139N/ACLASS="REFSECT1"
4139N/A><A
4139N/ANAME="AEN29"
4139N/A></A
4139N/A><H2
4139N/A>DESCRIPTION</H2
4139N/A><P
4139N/A><TT
4139N/ACLASS="FUNCTION"
4139N/A>lwres_getrrsetbyname()</TT
4139N/A>
4139N/Agets a set of resource records associated with a
4139N/A<TT
4139N/ACLASS="PARAMETER"
4139N/A><I
4139N/A>hostname</I
4139N/A></TT
4139N/A>,
4139N/A
4139N/A<TT
4139N/ACLASS="PARAMETER"
4139N/A><I
4139N/A>class</I
4139N/A></TT
4139N/A>,
4139N/A
4139N/Aand
4139N/A<TT
4139N/ACLASS="PARAMETER"
4139N/A><I
4139N/A>type</I
4139N/A></TT
4139N/A>.
4139N/A
4139N/A<TT
4139N/ACLASS="PARAMETER"
4139N/A><I
4139N/A>hostname</I
4139N/A></TT
4139N/A>
4139N/Ais
4139N/Aa pointer a to null-terminated string. The
4139N/A<TT
4139N/ACLASS="PARAMETER"
4139N/A><I
4139N/A>flags</I
4139N/A></TT
4139N/A>
4139N/Afield is currently unused and must be zero.</P
4139N/A><P
4139N/A>After a successful call to
4139N/A<TT
4139N/ACLASS="FUNCTION"
4139N/A>lwres_getrrsetbyname()</TT
4139N/A>,
4139N/A
4139N/A<TT
4139N/ACLASS="PARAMETER"
4139N/A><I
4139N/A>*res</I
4139N/A></TT
4139N/A>
4139N/Ais a pointer to an
4139N/A<SPAN
4139N/ACLASS="TYPE"
4139N/A>rrsetinfo</SPAN
4139N/A>
4139N/Astructure, containing a list of one or more
4139N/A<SPAN
4139N/ACLASS="TYPE"
4139N/A>rdatainfo</SPAN
4139N/A>
4139N/Astructures containing resource records and potentially another list of
4139N/A<SPAN
4139N/ACLASS="TYPE"
4139N/A>rdatainfo</SPAN
4139N/A>
4139N/Astructures containing SIG resource records
4139N/Aassociated with those records.
4139N/AThe members
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rri_rdclass</TT
4139N/A>
4139N/Aand
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rri_rdtype</TT
4139N/A>
4139N/Aare copied from the parameters.
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rri_ttl</TT
4139N/A>
4139N/Aand
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rri_name</TT
4139N/A>
4139N/Aare properties of the obtained rrset.
4139N/AThe resource records contained in
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rri_rdatas</TT
4139N/A>
4139N/Aand
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rri_sigs</TT
4139N/A>
4139N/Aare in uncompressed DNS wire format.
4139N/AProperties of the rdataset are represented in the
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rri_flags</TT
4139N/A>
4139N/Abitfield. If the RRSET_VALIDATED bit is set, the data has been DNSSEC
4139N/Avalidated and the signatures verified. </P
4139N/A><P
4139N/A>All of the information returned by
4139N/A<TT
4139N/ACLASS="FUNCTION"
4139N/A>lwres_getrrsetbyname()</TT
4139N/A>
4139N/Ais dynamically allocated: the
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rrsetinfo</TT
4139N/A>
4139N/Aand
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rdatainfo</TT
4139N/A>
4139N/Astructures,
4139N/Aand the canonical host name strings pointed to by the
4139N/A<TT
4139N/ACLASS="CONSTANT"
4139N/A>rrsetinfo</TT
4139N/A>structure.
4139N/A
4139N/AMemory allocated for the dynamically allocated structures created by
4139N/Aa successful call to
4139N/A<TT
4139N/ACLASS="FUNCTION"
4139N/A>lwres_getrrsetbyname()</TT
4139N/A>
4139N/Ais released by
4139N/A<TT
4139N/ACLASS="FUNCTION"
4139N/A>lwres_freerrset()</TT
4139N/A>.
4139N/A
4139N/A<TT
4139N/ACLASS="PARAMETER"
4139N/A><I
4139N/A>rrset</I
4139N/A></TT
4139N/A>
4139N/Ais a pointer to a
4139N/A<SPAN
4139N/ACLASS="TYPE"
4139N/A>struct rrset</SPAN
4139N/A>
4139N/Acreated by a call to
4139N/A<TT
4139N/ACLASS="FUNCTION"
4139N/A>lwres_getrrsetbyname()</TT
4139N/A>.&#13;</P
4139N/A><P
4139N/A></P
4139N/A></DIV
4139N/A><DIV
4139N/ACLASS="REFSECT1"
4139N/A><A
4139N/ANAME="AEN62"
4139N/A></A
4139N/A><H2
4139N/A>RETURN VALUES</H2
4139N/A><P
4139N/A><TT
4139N/ACLASS="FUNCTION"
4139N/A>lwres_getrrsetbyname()</TT
4139N/A>
4139N/Areturns zero on success, and one of the following error
4139N/Acodes if an error occurred:
4139N/A<P
4139N/A></P
4139N/A><DIV
4139N/ACLASS="VARIABLELIST"
4139N/A><DL
4139N/A><DT
4139N/A><TT
4139N/ACLASS="CONSTANT"
4139N/A>ERRSET_NONAME</TT
4139N/A></DT
4139N/A><DD
4139N/A><P
4139N/A>the name does not exist</P
4139N/A></DD
4139N/A><DT
4139N/A><TT
4139N/ACLASS="CONSTANT"
4139N/A>ERRSET_NODATA</TT
4139N/A></DT
4139N/A><DD
4139N/A><P
4139N/A>the name exists, but does not have data of the desired type</P
4139N/A></DD
4139N/A><DT
4139N/A><TT
4139N/ACLASS="CONSTANT"
4139N/A>ERRSET_NOMEMORY</TT
4139N/A></DT
4139N/A><DD
4139N/A><P
4139N/A>memory could not be allocated</P
4139N/A></DD
4139N/A><DT
4139N/A><TT
4139N/ACLASS="CONSTANT"
4139N/A>ERRSET_INVAL</TT
4139N/A></DT
4139N/A><DD
4139N/A><P
4139N/A>a parameter is invalid</P
4139N/A></DD
4139N/A><DT
4139N/A><TT
4139N/ACLASS="CONSTANT"
4139N/A>ERRSET_FAIL</TT
4139N/A></DT
4139N/A><DD
4139N/A><P
4139N/A>other failure</P
4139N/A></DD
4139N/A><DT
4139N/A><TT
4139N/ACLASS="CONSTANT"
4139N/A></TT
4139N/A></DT
4139N/A><DD
4139N/A><P
4139N/A></P
4139N/A></DD
4139N/A></DL
4139N/A></DIV
4139N/A>&#13;</P
4139N/A></DIV
4139N/A><DIV
4139N/ACLASS="REFSECT1"
4139N/A><A
4139N/ANAME="AEN97"
4139N/A></A
4139N/A><H2
4139N/A>SEE ALSO</H2
4139N/A><P
4139N/A><SPAN
4139N/ACLASS="CITEREFENTRY"
4139N/A><SPAN
4139N/ACLASS="REFENTRYTITLE"
4139N/A>lwres</SPAN
4139N/A>(3)</SPAN
4139N/A>.</P
4139N/A></DIV
4139N/A></BODY
4139N/A></HTML
4139N/A>