yev_get_state_name()

`yev_get_state_name()`#

yev_get_state_name() retrieves the name of the current state of the specified event.

C

Prototype

const char *yev_get_state_name(
    yev_event_h yev_event
);

Parameters

Key	Type	Description
`yev_event`	`yev_event_h`	The event handle whose state name is to be retrieved.

Return Value

A string representing the name of the current state of the event.

Notes

The returned string corresponds to one of the predefined event states.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python