gobj_stop_tree()

Stops the given gobj and all its child objects recursively. If the gobj is already being destroyed, it logs an error and returns immediately.

C

Prototype

int gobj_stop_tree(
    hgobj gobj
);

Parameters

Key	Type	Description
gobj	hgobj	The root object whose tree of child objects will be stopped.

---

Return Value

Returns 0 on success, or -1 if an error occurs (e.g., gobj is NULL or being destroyed).

Notes

If the gobj is already being destroyed, an error is logged and the function returns -1. This function first stops the given gobj and then recursively stops all its child objects. Uses gobj_walk_gobj_childs_tree() to traverse the child objects.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples