screen_get_event_property_pv()
Graphics and Screen4.0 (8.x)Screen Graphics Subsystem Developer's GuideAPIProgrammingUtilities
Retrieve the current value of the specified event property of type void*
Synopsis:
#include <screen/screen.h>
int screen_get_event_property_pv(screen_event_t ev,
int pname,
void **param)
Arguments:
- ev
- The handle of the event whose property is being queried. The event must have an event type of Screen event types.
- pname
- The name of the property whose value is being queried. The properties available for query are of type Screen property types.
- param
- The buffer where the retrieved value(s) is stored. This buffer must be of type
void*
.
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: Any
Event Type: SCREEN_EVENT_CLOSE
Event Type: SCREEN_EVENT_CREATE
Event Type: SCREEN_EVENT_DISPLAY
Event Type: SCREEN_EVENT_INPUT
Event Type: SCREEN_EVENT_INPUT_CONTROL
Event Type: SCREEN_EVENT_JOG
Event Type: SCREEN_EVENT_MANAGER
Event Types: SCREEN_EVENT_MTOUCH_PRETOUCH, SCREEN_EVENT_MTOUCH_TOUCH, SCREEN_EVENT_MTOUCH_MOVE, SCREEN_EVENT_MTOUCH_RELEASE
Event Type: SCREEN_EVENT_POST
Event Type: SCREEN_EVENT_PROPERTY
Event Type: SCREEN_EVENT_UNREALIZE
Note that when you're retrieving the following properties, Screen locally allocates resources to track the object that you retrieve:
Therefore, you must call the appropriate screen_destroy_*() function to free those resources when you no longer need to use the object in your local context.
Returns:
0
if successful, or -1
if an error occurred (errno
is set; refer to errno.h
for more details).
Page updated: