gobj_node_parents()
#
gobj_node_parents()
returns a list of parent references for a given node in a tree database, optionally filtered by a specific link.
Prototype
json_t *gobj_node_parents(
hgobj gobj,
const char *topic_name,
json_t *kw,
const char *link,
json_t *jn_options,
hgobj src
);
Parameters
Key |
Type |
Description |
---|---|---|
|
|
The GObj instance managing the tree database. |
|
|
The name of the topic representing the node. |
|
|
A JSON object containing the node’s primary key fields. Owned by the caller. |
|
|
The specific link to filter parent references. If NULL, all parent references are returned. |
|
|
A JSON object specifying options for retrieving parent references. Owned by the caller. |
|
|
The source GObj requesting the operation. |
Return Value
A JSON array containing the parent references. The caller must decrement the reference count when done.
Notes
[‘If gobj
is NULL or destroyed, an error is logged and NULL is returned.’, ‘If gobj->gclass->gmt->mt_node_parents
is not defined, an error is logged and NULL is returned.’, ‘The returned JSON array contains references formatted according to the specified options.’]
Prototype
// Not applicable in JS
Prototype
# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples