yev_get_state()

`yev_get_state()`#

yev_get_state() retrieves the current state of the specified event.

C

Prototype

yev_state_t yev_get_state(
    yev_event_h yev_event
);

Parameters

Key	Type	Description
`yev_event`	`yev_event_h`	Handle to the event whose state is being queried.

Return Value

Returns the current state of the event as a yev_state_t enumeration value.

Notes

The returned state can be one of YEV_ST_IDLE, YEV_ST_RUNNING, YEV_ST_CANCELING, or YEV_ST_STOPPED.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python