gobj_in_this_state()

`gobj_in_this_state()`#

Checks if the given hgobj is currently in the specified state.

C

Prototype

BOOL gobj_in_this_state(
    hgobj gobj,
    gobj_state_t state
);

Parameters

Key	Type	Description
`gobj`	`hgobj`	The `hgobj` instance to check.
`state`	`gobj_state_t`	The state to compare against the current state of `gobj`.

Return Value

Returns TRUE if gobj is in the specified state, otherwise returns FALSE.

Notes

This function is useful for verifying the current state of a hgobj before performing state-dependent operations.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python