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

NAME

7       getdns_list_get,   getdns_list_get_bindata,  getdns_list_get_data_type,
8       getdns_list_get_dict,   getdns_list_get_length,   getdns_list_get_list,
9       getdns_list_get_int -- get a value by index from a getdns list
10
11

LIBRARY

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

SYNOPSIS

17       #include <getdns.h>
18
19       getdns_return_t
20       getdns_list_get_bindata (getdns_list *this_list,
21          size_t index,
22          getdns_bindata **answer)
23
24       getdns_return_t
25       getdns_list_get_data_type (getdns_list *this_list,
26          size_t index,
27          getdns_data_type *answer)
28
29       getdns_return_t
30       getdns_list_get_dict (getdns_list *this_list,
31          size_t index,
32          getdns_dict **answer)
33
34       getdns_return_t
35       getdns_list_get_length (getdns_list *this_list,
36          size_t *answer)
37
38       getdns_return_t
39       getdns_list_get_list (getdns_list *this_list,
40          size_t index,
41          getdns_list **answer)
42
43       getdns_return_t
44       getdns_list_get_int (getdns_list *this_list,
45          size_t index,
46          uint32_t *answer)
47
48

DESCRIPTION

50       The getdns_list type is used to manage heterogeneous lists in which the
51       objects are each one of the data types:
52          getdns_bindata
53          getdns_dict
54          getdns_list
55          uint32_t
56
57
58       this_list the list from which to retrieve the object
59
60       index the numeric index (0 based) of the item in  the  list  you  would
61       like copied to answer
62
63       answer a copy of the object in the list is placed in answer, the caller
64       is responsible for freeing the storage associated with that  object  by
65       calling the appropriate destroy function.
66
67

RETURN VALUES

69       Upon  successful  completion  the functions return GETDNS_RETURN_GOOD ,
70       otherwise the following error values are returned:
71
72       GETDNS_RETURN_GENERIC_ERROR if this_list is not a valid list
73
74       GETDNS_RETURN_NO_SUCH_LIST_ITEM if index is out of range
75
76       GETDNS_RETURN_WRONG_TYPE_REQUESTED if the requested data  type  doesn't
77       match the contents of the indexed argument
78
79

EXAMPLES

81       TBD
82
83

SEE ALSO

85       libgetdns(3),   getdns_address(3),  getdns_dict(3),  getdns_general(3),
86       getdns_hostname(3), getdns_service(3),
87
88
89
90
91getdns 1.6.0                     December 2015                  getdns_list(3)
Impressum