gobj_has_state()

gobj_has_state()#

Checks if the given gobj has the specified state in its state machine.

Prototype

BOOL gobj_has_state(
    hgobj gobj, 
    gobj_state_t state
);

Parameters

Key

Type

Description

gobj

hgobj

The gobj instance to check.

state

gobj_state_t

The state to verify in the gobj’s state machine.


Return Value

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

Notes

This function verifies if the given state exists in the state machine of the gobj. It does not check if the gobj is currently in that state.

Prototype

// Not applicable in JS

Prototype

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