screen_get_event_property_*()

Get the current value of an event property

Function type:

Immediate execution

Synopsis:

#include <screen/screen.h>

int screen_get_event_property_cv( screen_event_t ev,
                                  int pname,
                                  int len,
                                  char * param );

int screen_get_event_property_iv( screen_event_t ev,
                                  int pname,
                                  int * param );

int screen_get_event_property_llv( screen_event_t ev,
                                   int pname,
                                   long long * param );

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.
pname
The name of the property whose value is requested. The properties that can be queried with these functions are listed (by event type) below:
  • Event type: SCREEN_EVENT_CLOSE
    • SCREEN_PROPERTY_WINDOW
  • Event type: SCREEN_EVENT_CREATE
    • SCREEN_PROPERTY_WINDOW
    • SCREEN_PROPERTY_GROUP
  • Event type: SCREEN_EVENT_DISPLAY
    • SCREEN_PROPERTY_DISPLAY
    • SCREEN_PROPERTY_ATTACHED
    • SCREEN_PROPERTY_MIRROR_MODE
    • SCREEN_PROPERTY_MODE
    • SCREEN_PROPERTY_PROTECTION_ENABLE
  • Event type: SCREEN_EVENT_IDLE
    • SCREEN_PROPERTY_IDLE_STATE
  • Event type: SCREEN_EVENT_INPUT
    • SCREEN_PROPERTY_DEVICE_INDEX
  • Event type: SCREEN_EVENT_JOG
    • SCREEN_PROPERTY_DEVICE_INDEX
  • Event type: SCREEN_EVENT_KEYBOARD
    • SCREEN_PROPERTY_DEVICE_INDEX
    • SCREEN_PROPERTY_KEY_CAP
    • SCREEN_PROPERTY_KEY_FLAGS
    • SCREEN_PROPERTY_KEY_MODIFIERS
    • SCREEN_PROPERTY_KEY_SCAN
    • SCREEN_PROPERTY_KEY_SYM
  • Event type: SCREEN_EVENT_MTOUCH_RELEASE
    • SCREEN_PROPERTY_TIMESTAMP
    • SCREEN_PROPERTY_POSITION
    • SCREEN_PROPERTY_SEQUENCE_ID
    • SCREEN_PROPERTY_SIZE
    • SCREEN_PROPERTY_SOURCE_POSITION
    • SCREEN_PROPERTY_SOURCE_SIZE
    • SCREEN_PROPERTY_TOUCH_ID
    • SCREEN_PROPERTY_TOUCH_ORIENTATION
    • SCREEN_PROPERTY_TOUCH_PRESSURE
    • SCREEN_PROPERTY_TIMESTAMP
    • SCREEN_PROPERTY_WINDOW
  • Event type: SCREEN_EVENT_POINTER
    • SCREEN_PROPERTY_BUTTONS
    • SCREEN_PROPERTY_DEVICE_INDEX
    • SCREEN_PROPERTY_POSITION
    • SCREEN_PROPERTY_SOURCE_POSITION
    • SCREEN_PROPERTY_WINDOW
  • Event type: SCREEN_EVENT_POST
    • SCREEN_PROPERTY_WINDOW
  • Event type: SCREEN_EVENT_PROPERTY
    • SCREEN_PROPERTY_NAME
    • SCREEN_PROPERTY_WINDOW
    • SCREEN_PROPERTY_OBJECT_TYPE
  • Event type: SCREEN_EVENT_USER
    • SCREEN_PROPERTY_USER_DATA
len
(screen_get_event_property_cv() only). The maximum number of bytes that can be written to param.
param
A pointer to a buffer where the values will be stored.

Library

screen

Description

These functions store the current value of an event property in a user-provided array. No more than len bytes will be written. You can set event properties with the screen_set_event_property() function.

Returns

0
The function succeeded and the value (or values) of the property are stored in the buffer provided.
-1
An error occurred (errno is set).

Classification

Windowing API

Safety  Value  
Interrupt handler No
Signal handler No
Thread Yes