screen_get_event_property_cv()
Graphics and Screen4.0 (8.x)Screen Graphics Subsystem Developer's GuideAPIProgrammingUtilities
Retrieve the current value of the specified event property of type char
Synopsis:
#include <screen/screen.h>
int screen_get_event_property_cv(screen_event_t ev,
int pname,
int len,
char *param)
Arguments:
- ev
- The handle of the event whose property is being queried.
- pname
- The name of the property whose value is being queried. The properties available for query are of type Screen property types.
- len
- The maximum number of bytes that Screen can write to param.
- param
- The buffer where Screen stores the retrieved value (a character array that includes a terminating null character). This buffer must be an array of type
char
with a minimum length of len. If this user-provided buffer has insufficient space for storing the property being retrieved, Screen truncates the retrieved value and returns the character array without a terminating null character.
Library:
libscreenDescription:
Function Type: Immediate Execution
This function stores the current value of an event property in a user-provided buffer. The list of properties that can be queried per event type are listed as follows:
Event Type: SCREEN_EVENT_CREATE
Event Type: SCREEN_EVENT_MANAGER
Returns:
0
if successful, or -1
if an error occurred (errno
is set; refer to errno.h
for more details).
Page updated: