getdns_dict(3)

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

NAME

7       getdns_dict, getdns_dict_create, getdns_dict_create_with_extended_mem‐
8       ory_functions, getdns_dict_create_with_memory_functions,
9       getdns_dict_destroy -- getdns dict create and destroy routines
10
11

LIBRARY

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

SYNOPSIS

17       #include <getdns.h>
18
19       getdns_dict *
20       getdns_dict_create ()
21
22       getdns_dict *
23       getdns_dict_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_dict *

getdns_dict_create_with_memory_functions

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

getdns_dict_destroy (getdns_dict *this_dict)

37
38

DESCRIPTION

40       The  getdns_dict  type  is used to manage name/value pairs in which the
41       names are strings and the data types of the  values  are  heterogeneous
42       and 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  dictionary  before  destroying  the  dictionary.
51       There  are a number of helper functions that provide access to the dic‐
52       tionary object, see 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       this_dict the dictionary to destroy
60
61

RETURN VALUES

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

EXAMPLES

70       TBD
71
72