[getdns-api] Destroy names from

[Willem Toorop]

Dear list,

In he last paragraph of section 2. "Data structures in the API", is the
following:

	"The helper getter functions return references to getdns_dict,
getdns_list and getdns_bindata data structures. The user must not
directly destroy these retrieved "child" data structures; instead, they
will automatically be destroyed when the containing "parent" data
structure is destroyed. Because of this, retrieved "child" data
structures cannot be used any more after the containing "parent" data
structure has been destroyed."

This is true in our implementation except for the getdns_dict_get_names
helper function that returns a newly created list containing all the
names in the dict.

We would like to insert a paragraph before the last paragraph so that
the last two paragraphs of section two will be:

	"The getdns_dict_get_names helper function creates a newly created list
containing the names in a dict.  The caller is responsible for disposing
this list.

	Except for getdns_dict_get_names, all the helper getter functions
return references to getdns_dict, getdns_list and getdns_bindata data
structures. The user must not directly destroy these retrieved "child"
data structures; instead, they will automatically be destroyed when the
containing "parent" data structure is destroyed. Because of this,
retrieved "child" data structures cannot be used any more after the
containing "parent" data structure has been destroyed."

OK?  Comments/improvements welcome.

-- Willem
_______________________________________________
getdns-api mailing list
getdns-api at vpnc.org