mirror of https://github.com/getdnsapi/getdns.git
139 lines
3.4 KiB
Groff
139 lines
3.4 KiB
Groff
.\" The "BSD-New" License
|
|
.\"
|
|
.\" Copyright (c) 2013, NLNet Labs, Verisign, 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 names of the copyright holders 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_set 3 "@date@" "getdns @version@" getdns
|
|
.SH NAME
|
|
.B getdns_list_set,
|
|
.B getdns_list_set_bindata,
|
|
.B getdns_list_set_dict,
|
|
.B getdns_list_set_int,
|
|
.B getdns_list_set_list,
|
|
-- set a value by index from a getdns list
|
|
|
|
.SH LIBRARY
|
|
DNS Resolver library (libgetdns, \-lgetdns)
|
|
|
|
.SH SYNOPSIS
|
|
#include <getdns.h>
|
|
|
|
getdns_return_t
|
|
.br
|
|
.B getdns_list_set_bindata
|
|
(getdns_list *this_list,
|
|
.RS 3
|
|
size_t index,
|
|
.br
|
|
getdns_bindata *child_bindata)
|
|
.RE
|
|
|
|
getdns_return_t
|
|
.br
|
|
.B getdns_list_set_dict
|
|
(getdns_list *this_list,
|
|
.RS 3
|
|
size_t index,
|
|
.br
|
|
getdns_dict *child_dict)
|
|
.RE
|
|
|
|
getdns_return_t
|
|
.br
|
|
.B getdns_list_set_int
|
|
(getdns_list *this_list,
|
|
.RS 3
|
|
size_t index,
|
|
.br
|
|
uint32_t child_uint32_t)
|
|
.RE
|
|
|
|
getdns_return_t
|
|
.br
|
|
.B getdns_list_set_list
|
|
(getdns_list *this_list,
|
|
.RS 3
|
|
size_t index,
|
|
.br
|
|
getdns_list *child_list)
|
|
.RE
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.LP
|
|
The getdns_list type is used to manage a heterogeneous indexed list of values that include:
|
|
.RS 3
|
|
.br
|
|
getdns_bindata
|
|
.br
|
|
getdns_dict
|
|
.br
|
|
getdns_list
|
|
.br
|
|
uint32_t
|
|
.RE
|
|
|
|
.LP
|
|
.I this_list
|
|
the list in which to add/update the indexed item
|
|
.LP
|
|
.I index
|
|
the index whose associated value is to be set. If the index exists in the list
|
|
the value associated with that index is replaced, if the index does not exist in the
|
|
list a new item is added to the list at the specified index.
|
|
.LP
|
|
.I child_bindata
|
|
.I child_dict
|
|
.I child_list
|
|
.I child_uint32
|
|
value to assign the indexed element
|
|
|
|
.SH "RETURN VALUES"
|
|
|
|
Upon successful completion the functions return
|
|
.B GETDNS_RETURN_GOOD
|
|
, otherwise the following error values are returned:
|
|
.LP
|
|
.B GETDNS_RETURN_NO_SUCH_LIST_ITEM
|
|
if the index is out of range
|
|
.LP
|
|
.B GETDNS_RETURN_GENERIC_ERROR
|
|
if this_list is not a valid list
|
|
|
|
.SH EXAMPLES
|
|
|
|
TBD
|
|
|
|
.SH SEE ALSO
|
|
.BR libgetdns (3),
|
|
.BR getdns_address (3),
|
|
.BR getdns_list (3),
|
|
.BR getdns_list_get (3),
|
|
.BR getdns_general (3),
|
|
.BR getdns_hostname (3),
|
|
.BR getdns_service (3),
|
|
|