treedb_clean_node()

treedb_clean_node()#

treedb_clean_node() removes all foreign key links from a given node in the tree database, effectively disconnecting it from its parent and child relationships.

Prototype

int treedb_clean_node(
    json_t  *tranger,
    json_t  *node,   // NOT owned, pure node
    BOOL     save
);

Parameters

Key

Type

Description

tranger

json_t *

Pointer to the TimeRanger database instance.

node

json_t *

The target node to be cleaned. This node is not owned by the function.

save

BOOL

If TRUE, the changes are saved to the database.


Return Value

Returns 0 on success, or a negative error code on failure.

Notes

This function only removes foreign key links; it does not delete the node itself. If save is TRUE, the changes are persisted in the database.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples