screen_get_session_property_iv()
Graphics and Screen4.0 (8.x)Screen Graphics Subsystem Developer's GuideAPIProgrammingUtilities
Retrieve the current value of the specified session property of type integer
Synopsis:
#include <screen/screen.h>
int screen_get_session_property_iv(screen_session_t ssn,
int pname,
int *param)
Arguments:
- ssn
- The handle of the session 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.
- param
- A pointer to a buffer where this function stores the retrieved value(s). This buffer must be of type
int
. The buffer may be a single integer or an array of integers, depending on the property being retrieved.
Library:
libscreenDescription:
Function Type: Flushing Execution
This function stores the current value of a session property in a user-provided buffer.
The values of the following properties can be retrieved using this function:
- SCREEN_PROPERTY_ACCELERATION (for SCREEN_EVENT_GAMEPAD, SCREEN_EVENT_JOG, and SCREEN_EVENT_JOYSTICK only)
- SCREEN_PROPERTY_BRUSH (for SCREEN_EVENT_MTOUCH_TOUCH and SCREEN_EVENT_POINTER)
- SCREEN_PROPERTY_BRUSH_CLIP_POSITION
- SCREEN_PROPERTY_BRUSH_CLIP_SIZE
- SCREEN_PROPERTY_CURSOR
- SCREEN_PROPERTY_DEVICE_COUNT
- SCREEN_PROPERTY_FOCUS
- SCREEN_PROPERTY_GESTURE_PARAMETERS (for SCREEN_EVENT_GAMEPAD, SCREEN_EVENT_JOG, and SCREEN_EVENT_JOYSTICK only)
- SCREEN_PROPERTY_ID [1]
- SCREEN_PROPERTY_METRIC_COUNT [1]
- SCREEN_PROPERTY_MODE (for SCREEN_EVENT_GAMEPAD, SCREEN_EVENT_JOG, SCREEN_EVENT_JOYSTICK, and SCREEN_EVENT_MTOUCH_TOUCH only)
- SCREEN_PROPERTY_MTOUCH_FOCUS
- SCREEN_PROPERTY_OWNER_PID [1]
- SCREEN_PROPERTY_PERMISSIONS
- SCREEN_PROPERTY_POINTER_FOCUS
- SCREEN_PROPERTY_POSITION
- SCREEN_PROPERTY_PROTECTION_ENABLE
- SCREEN_PROPERTY_SCALE_FACTOR [1]
- SCREEN_PROPERTY_SENSITIVITY
- SCREEN_PROPERTY_SENSITIVITY_THRESHOLD
- SCREEN_PROPERTY_SEQUENCE_ID
- SCREEN_PROPERTY_SIZE
- SCREEN_PROPERTY_SPEED (for SCREEN_EVENT_GAMEPAD, SCREEN_EVENT_JOG, and SCREEN_EVENT_JOYSTICK only)
- SCREEN_PROPERTY_STATUS
- SCREEN_PROPERTY_TRANSFORM [1]
- SCREEN_PROPERTY_TYPE [1]
- SCREEN_PROPERTY_VISIBLE
- SCREEN_PROPERTY_ZORDER
Note [1]: When retrieving this property, the function type is Immediate Execution.
Returns:
0
if successful, or -1
if an error occurred (errno
is set; refer to errno.h
for more details).
Page updated: