screen_destroy_event()

Updated: April 19, 2023

Destroy an event and free associated memory

Synopsis:

#include <screen/screen.h>
int screen_destroy_event(screen_event_t ev)

Arguments:

ev
The handle of the event to destroy. This event must have been created with screen_create_event().

Library:

libscreen

Description:

Function Type: Immediate Execution

This function frees the memory allocated to hold an event. The event can no longer be used as an argument in subsequent Screen API calls.

Returns:

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