mirror of https://github.com/getdnsapi/getdns.git
129 lines
3.7 KiB
Groff
129 lines
3.7 KiB
Groff
|
.\" The "BSD-New" License
|
||
|
|
.\"
|
||
|
|
.\" Copyright (c) 2013, Versign, Inc.
|
||
|
|
.\" 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.
|
||
|
|
.\" * Neither the name of the <organization> nor the
|
||
|
|
.\" 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_get_bindata,
|
||
|
|
.B getdns_list_get_data_type,
|
||
|
|
.B getdns_list_get_dict,
|
||
|
|
.B getdns_list_get_length,
|
||
|
|
.B getdns_list_get_list,
|
||
|
|
.B getdns_list_get_int
|
||
|
|
|
||
|
|
.SH LIBRARY
|
||
|
|
DNS Resolver library (libgetdns, -lgetdns)
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
#include <getdns.h>
|
||
|
|
|
||
|
|
getdns_return_t
|
||
|
|
.br
|
||
|
|
.B getdns_list_get_bindata
|
||
|
|
(struct getdns_list *this_list, size_t index, struct getdns_bindata **answer)
|
||
|
|
|
||
|
|
getdns_return_t
|
||
|
|
.br
|
||
|
|
.B getdns_list_get_data_type
|
||
|
|
(struct getdns_list *this_list, size_t index, getdns_data_type *answer)
|
||
|
|
|
||
|
|
getdns_return_t
|
||
|
|
.br
|
||
|
|
.B getdns_list_get_dict
|
||
|
|
(struct getdns_list *this_list, size_t index, struct getdns_dict **answer)
|
||
|
|
|
||
|
|
getdns_return_t
|
||
|
|
.br
|
||
|
|
.B getdns_list_get_length
|
||
|
|
(struct getdns_list *this_list, size_t *answer)
|
||
|
|
|
||
|
|
getdns_return_t
|
||
|
|
.br
|
||
|
|
.B getdns_list_get_list
|
||
|
|
(struct getdns_list *this_list, size_t index, struct getdns_list **answer)
|
||
|
|
|
||
|
|
getdns_return_t
|
||
|
|
.br
|
||
|
|
.B getdns_list_get_int
|
||
|
|
(struct getdns_list *this_list, size_t index, uint32_t *answer)
|
||
|
|
|
||
|
|
.SH DESCRIPTION
|
||
|
|
|
||
|
|
.LP
|
||
|
|
The getdns_list type is used to manage heterogenous lists in which the objects are each one of the data types:
|
||
|
|
.RS 3
|
||
|
|
.br
|
||
|
|
struct getdns_bindata
|
||
|
|
.br
|
||
|
|
struct getdns_dict
|
||
|
|
.br
|
||
|
|
struct getdns_list
|
||
|
|
.br
|
||
|
|
uint32_t
|
||
|
|
.RE
|
||
|
|
|
||
|
|
.LP
|
||
|
|
.I this_list
|
||
|
|
the list from which to retrieve the object
|
||
|
|
.LP
|
||
|
|
.I index
|
||
|
|
the numeric index (0 based) of the item in the list you would like copied to answer
|
||
|
|
.LP
|
||
|
|
.I answer
|
||
|
|
a copy of the object in the list is placed in answer, the caller is responsible
|
||
|
|
for freeing the storage associated with that object by calling the appropriate
|
||
|
|
destroy function.
|
||
|
|
|
||
|
|
.SH "RETURN VALUES"
|
||
|
|
|
||
|
|
Upon successful completion the functions return
|
||
|
|
.B GETDNS_RETURN_GOOD
|
||
|
|
, otherwise the following error values are returned:
|
||
|
|
.LP
|
||
|
|
.B GETDNS_RETURN_GENERIC_ERROR
|
||
|
|
if this_list is not a valid list
|
||
|
|
.LP
|
||
|
|
.B GETDNS_RETURN_NO_SUCH_LIST_ITEM
|
||
|
|
if index is out of range
|
||
|
|
.LP
|
||
|
|
.B GETDNS_RETURN_WRONG_TYPE_REQUESTED
|
||
|
|
if the requested data type doesn't match the contents of the indexed argument
|
||
|
|
|
||
|
|
.SH EXAMPLES
|
||
|
|
|
||
|
|
TBD
|
||
|
|
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR libgetdns (3),
|
||
|
|
.BR getdns_address (3),
|
||
|
|
.BR getdns_dict (3),
|
||
|
|
.BR getdns_general (3),
|
||
|
|
.BR getdns_hostname (3),
|
||
|
|
.BR getdns_service (3),
|
||
|
|
|