screen_create_event()

Updated: October 26, 2022

Create an event that can later be filled with event data

Synopsis:

#include <screen/screen.h>
int screen_create_event(screen_event_t *pev)

Arguments:

pev
An address where the function can store a handle to the native event.

Library:

libscreen

Description:

Function Type: Immediate Execution

This function creates an event object. This event can be used to store events from the event queue of the process by using screen_get_event(). Event data can also be filled in with the screen_set_event_property_*() functions and sent to other applications using screen_inject_event() or screen_send_event(). Events are opaque handles. The screen_get_event_property_*() functions must be used to get information from the event. You must destroy event objects when you no longer need them by using screen_destroy_event().

Returns:

0 if successful, or -1 if an error occurred (errno is set; refer to errno.h for more details).