mirror of https://github.com/getdnsapi/getdns.git
69 lines
2.3 KiB
Groff
69 lines
2.3 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_pretty_print_dict 3 "@date@" "getdns @version@" getdns
|
|
.SH NAME
|
|
.B getdns_pretty_print_dict
|
|
-- return a string representation of a getdns dict
|
|
|
|
.SH LIBRARY
|
|
DNS Resolver library (libgetdns, -lgetdns)
|
|
|
|
.SH SYNOPSIS
|
|
#include <getdns.h>
|
|
|
|
getdns_list *
|
|
.br
|
|
.B getdns_pretty_print_dict
|
|
(const getdns_dict *this_dict)
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.LP
|
|
Helper function that returns a string of nicely formatted data including all of the
|
|
elements in the dict.
|
|
|
|
.HP 3
|
|
.I this_dict
|
|
the dictionary to render as a string
|
|
|
|
.HP
|
|
.SH "RETURN VALUES"
|
|
|
|
Returns a string that the calling function must free (it is allocated using the
|
|
system allocator not the user defined allocator). Returns NULL if there is an error.
|
|
|
|
.SH EXAMPLES
|
|
|
|
TBD
|
|
|
|
.SH SEE ALSO
|
|
.BR getdns_dict (3)
|
|
.BR libgetdns (3)
|
|
|