getdns_list(3)

1
2getdns_list(3)                      getdns                      getdns_list(3)
3
4
5

NAME

7       getdns_list, getdns_list_create, getdns_list_create_with_extended_mem‐
8       ory_functions, getdns_list_create_with_memory_functions,
9       getdns_list_destroy -- getdns list create and destroy routines
10
11

LIBRARY

13       DNS Resolver library (libgetdns, -lgetdns)
14
15

SYNOPSIS

17       #include <getdns.h>
18
19       getdns_list *
20       getdns_list_create ()
21
22       getdns_list *
23       getdns_list_create_with_extended_memory_functions
24          (void *userarg,
25          void *(*malloc)(void *userarg, size_t sz),
26          void *(*realloc)(void *userarg, void *buf, size_t sz),
27          void (*free)(void *userarg, void *buf)
28
29getdns_list *

getdns_list_create_with_memory_functions

31   (void *userarg,
32   void *(*malloc)(size_t sz),
33   void *(*realloc)(void *buf, size_t sz),
34   void (*free)(void *buf)
35
36void

getdns_list_destroy (getdns_list *this_dict)

38
39

DESCRIPTION

41       The  getdns_list  type  is  used  to manage heterogeneous indexed lists
42       name/value pairs in which the data types of the values include
43          getdns_bindata
44          getdns_dict
45          getdns_list
46          uint32_t
47
48
49       The destroy function performs a "deep" destroy, freeing storage for all
50       of  the  members  of  the list before destroying the list.  There are a
51       number of helper functions that provide access to the list object,  see
52       their respective man pages.
53
54
55       userarg  pass  this  argument  to  the user specified memory management
56       functions for operations on lists created using extended  memory  func‐
57       tions
58
59
60       this_list the list to destroy
61
62

RETURN VALUES

64       Upon  successful  completion  the getdns_list_create function returns a
65       valid (empty) list structure  that  should  be  freed  via  a  call  to
66       getdns_list_destroy.  If a parameter in invalid or in the event of some
67       error getdns_list_create returns NULL.
68
69

EXAMPLES

71       TBD
72
73