gobj_node_tree()

`gobj_node_tree()`#

Returns the full hierarchical tree of a node in a given topic. The tree is duplicated and can include metadata if specified in jn_options.

C

Prototype

json_t *gobj_node_tree(
    hgobj gobj,
    const char *topic_name,
    json_t *kw,
    json_t *jn_options,
    hgobj src
);

Parameters

Key	Type	Description
`gobj`	`hgobj`	The GObj instance that manages the tree database.
`topic_name`	`const char *`	The name of the topic whose node tree is to be retrieved.
`kw`	`json_t *`	A JSON object containing the ‘id’ and primary key fields used to locate the root node. Owned by the function.
`jn_options`	`json_t *`	A JSON object specifying options such as ‘with_metadata’ to include metadata in the response. Owned by the function.
`src`	`hgobj`	The source GObj requesting the node tree.

Return Value

A JSON object representing the full hierarchical tree of the specified node. The caller must free the returned JSON object.

Notes

[‘If gobj is NULL or destroyed, an error is logged and NULL is returned.’, ‘If gobj does not implement mt_node_tree, an error is logged and NULL is returned.’, ‘The returned JSON object must be freed by the caller using json_decref().’]

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

gobj_node_tree()

gobj_node_tree()#

`gobj_node_tree()`#