2014-02-19 16:30:01 -06:00
|
|
|
.\" The "BSD-New" License
|
|
|
|
|
.\"
|
2014-02-20 08:12:19 -06:00
|
|
|
.\" Copyright (c) 2013, NLNet Labs, Verisign, Inc.
|
2014-02-19 16:30:01 -06:00
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions are met:
|
|
|
|
|
.\" * Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" * Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
2014-02-25 07:23:19 -06:00
|
|
|
.\" * Neither the names of the copyright holders nor the
|
2014-02-19 16:30:01 -06:00
|
|
|
.\" names of its contributors may be used to endorse or promote products
|
|
|
|
|
.\" derived from this software without specific prior written permission.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
|
|
|
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
|
|
|
.\" DISCLAIMED. IN NO EVENT SHALL Verisign, Inc. BE LIABLE FOR ANY
|
|
|
|
|
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
|
|
|
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
|
|
|
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
|
|
|
.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
|
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
|
|
|
.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
|
|
|
|
|
.TH getdns_list 3 "@date@" "getdns @version@" getdns
|
|
|
|
|
.SH NAME
|
|
|
|
|
.B getdns_list,
|
|
|
|
|
.B getdns_list_create,
|
|
|
|
|
.B getdns_list_destroy
|
|
|
|
|
|
|
|
|
|
.SH LIBRARY
|
|
|
|
|
DNS Resolver library (libgetdns, -lgetdns)
|
|
|
|
|
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
#include <getdns.h>
|
|
|
|
|
|
2014-02-20 16:29:39 -06:00
|
|
|
getdns_list *
|
2014-02-19 16:30:01 -06:00
|
|
|
.br
|
|
|
|
|
.B getdns_list_create
|
|
|
|
|
()
|
|
|
|
|
|
|
|
|
|
void
|
|
|
|
|
.br
|
|
|
|
|
.B getdns_list_destroy
|
2014-02-20 16:29:39 -06:00
|
|
|
(getdns_list *this_dict)
|
2014-02-19 16:30:01 -06:00
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
|
|
|
|
|
.LP
|
2014-02-19 17:18:52 -06:00
|
|
|
The getdns_list type is used to manage heterogeneous indexed lists name/value pairs in which the data types of the values include
|
2014-02-19 16:30:01 -06:00
|
|
|
.RS 3
|
|
|
|
|
.br
|
2014-02-20 16:29:39 -06:00
|
|
|
getdns_bindata
|
2014-02-19 16:30:01 -06:00
|
|
|
.br
|
2014-02-20 16:29:39 -06:00
|
|
|
getdns_dict
|
2014-02-19 16:30:01 -06:00
|
|
|
.br
|
2014-02-20 16:29:39 -06:00
|
|
|
getdns_list
|
2014-02-19 16:30:01 -06:00
|
|
|
.br
|
|
|
|
|
uint32_t
|
|
|
|
|
.RE
|
|
|
|
|
|
|
|
|
|
.LP
|
|
|
|
|
The destroy function performs a "deep" destroy, freeing storage for all of the members
|
|
|
|
|
of the list before destroying the list. There are a number of helper
|
|
|
|
|
functions that provide access to the list object, see their respective man pages.
|
|
|
|
|
|
|
|
|
|
.LP
|
|
|
|
|
.I this_list
|
|
|
|
|
the list to destroy
|
|
|
|
|
.LP
|
|
|
|
|
|
|
|
|
|
.SH "RETURN VALUES"
|
|
|
|
|
|
|
|
|
|
Upon successful completion the getdns_list_create function returns a valid (empty)
|
|
|
|
|
list structure that should be freed via a call to getdns_list_destroy.
|
|
|
|
|
|
|
|
|
|
.SH EXAMPLES
|
|
|
|
|
|
|
|
|
|
TBD
|
|
|
|
|
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR libgetdns (3),
|
|
|
|
|
.BR getdns_dict (3),
|
|
|
|
|
.BR getdns_list_get (3),
|
|
|
|
|
.BR getdns_list_set (3)
|
|
|
|
|
|
