gobj_start()

gobj_start()#

The gobj_start() function starts the specified hgobj instance, transitioning it to a running state if it is not already running. It verifies required attributes before starting and invokes the mt_start method of the associated gclass if defined.

Prototype

int gobj_start(
    hgobj gobj
);

Parameters

Key

Type

Description

gobj

hgobj

The hgobj instance to be started.


Return Value

Returns 0 on success, or -1 if the gobj is already running, disabled, or missing required attributes.

Notes

If the gobj is already running, an error is logged and the function returns -1. If the gobj is disabled, it cannot be started. Before starting, the function checks for required attributes and logs an error if any are missing. If the gclass has an mt_start method, it is invoked to perform additional start operations.

Prototype

// Not applicable in JS

Prototype

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