lwres_getrrsetbyname.html revision 33d0a7767d53cb366039fd0ac4f63cf8a9c351b0
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - Copyright (C) 2004, 2005, 2007, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - Copyright (C) 2000, 2001 Internet Software Consortium.
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - Permission to use, copy, modify, and/or distribute this software for any
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - purpose with or without fee is hereby granted, provided that the above
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - copyright notice and this permission notice appear in all copies.
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync - PERFORMANCE OF THIS SOFTWARE.
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<p>lwres_getrrsetbyname, lwres_freerrset — retrieve DNS records</p>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;">
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<b class="fsfunc">lwres_getrrsetbyname</b>(</code></td>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<td>const char *<var class="pdparam">hostname</var>, </td>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<td>unsigned int <var class="pdparam">rdclass</var>, </td>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<td>unsigned int <var class="pdparam">rdtype</var>, </td>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<td>unsigned int <var class="pdparam">flags</var>, </td>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<td>struct rrsetinfo **<var class="pdparam">res</var><code>)</code>;</td>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<td>struct rrsetinfo *<var class="pdparam">rrset</var><code>)</code>;</td>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync The following structures are used:
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsyncstruct rdatainfo {
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync unsigned int rdi_length; /* length of data */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync unsigned char *rdi_data; /* record data */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsyncstruct rrsetinfo {
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync unsigned int rri_flags; /* RRSET_VALIDATED... */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync unsigned int rri_rdclass; /* class number */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync unsigned int rri_rdtype; /* RR type number */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync unsigned int rri_ttl; /* time to live */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync unsigned int rri_nrdatas; /* size of rdatas array */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync unsigned int rri_nsigs; /* size of sigs array */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync char *rri_name; /* canonical name */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync struct rdatainfo *rri_rdatas; /* individual records */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync struct rdatainfo *rri_sigs; /* individual signatures */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<p><code class="function">lwres_getrrsetbyname()</code>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync gets a set of resource records associated with a
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <em class="parameter"><code>hostname</code></em>, <em class="parameter"><code>class</code></em>,
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <em class="parameter"><code>hostname</code></em> is a pointer a to
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync null-terminated string. The <em class="parameter"><code>flags</code></em> field
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync is currently unused and must be zero.
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync After a successful call to
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <code class="function">lwres_getrrsetbyname()</code>,
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <em class="parameter"><code>*res</code></em> is a pointer to an
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <span class="type">rrsetinfo</span> structure, containing a list of one or
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync more <span class="type">rdatainfo</span> structures containing resource
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync records and potentially another list of <span class="type">rdatainfo</span>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync structures containing SIG resource records associated with those
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync records. The members <code class="constant">rri_rdclass</code> and
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <code class="constant">rri_rdtype</code> are copied from the parameters.
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <code class="constant">rri_ttl</code> and <code class="constant">rri_name</code>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync are properties of the obtained rrset. The resource records
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync contained in <code class="constant">rri_rdatas</code> and
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <code class="constant">rri_sigs</code> are in uncompressed DNS wire
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync format. Properties of the rdataset are represented in the
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <code class="constant">rri_flags</code> bitfield. If the RRSET_VALIDATED
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync bit is set, the data has been DNSSEC validated and the
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync signatures verified.
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync All of the information returned by
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <code class="function">lwres_getrrsetbyname()</code> is dynamically
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync allocated: the <code class="constant">rrsetinfo</code> and
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <code class="constant">rdatainfo</code> structures, and the canonical
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync host name strings pointed to by the
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync Memory allocated for the dynamically allocated structures
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync created by a successful call to
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <code class="function">lwres_getrrsetbyname()</code> is released by
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <em class="parameter"><code>rrset</code></em> is a pointer to a <span class="type">struct
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync rrset</span> created by a call to
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync <code class="function">lwres_getrrsetbyname()</code>.
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<p><code class="function">lwres_getrrsetbyname()</code>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync returns zero on success, and one of the following error codes if
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync an error occurred:
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<dt><span class="term"><code class="constant">ERRSET_NONAME</code></span></dt>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync the name does not exist
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<dt><span class="term"><code class="constant">ERRSET_NODATA</code></span></dt>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync the name exists, but does not have data of the desired type
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<dt><span class="term"><code class="constant">ERRSET_NOMEMORY</code></span></dt>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync memory could not be allocated
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<dt><span class="term"><code class="constant">ERRSET_INVAL</code></span></dt>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync a parameter is invalid
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<dt><span class="term"><code class="constant">ERRSET_FAIL</code></span></dt>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync other failure
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<dt><span class="term"><code class="constant"></code></span></dt>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync<p><span class="citerefentry"><span class="refentrytitle">lwres</span>(3)</span>.