gobj_current_state()

gobj_current_state()#

Retrieves the current state of the given hgobj.

Prototype

gobj_state_t gobj_current_state(
    hgobj hgobj
);

Parameters

Key

Type

Description

hgobj

hgobj

The hgobj whose current state is to be retrieved.


Return Value

Returns the current state of the hgobj as a gobj_state_t string.

Notes

If hgobj is NULL, an error is logged, and an empty string is returned.

Prototype

// Not applicable in JS

Prototype

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