screen_get_group_property_*()

Gets the current value of a group property

Function type:

Flushing execution

Synopsis:

#include <screen/screen.h>

int screen_get_group_property_cv( screen_group_t grp, 
                                  int pname, 
                                  int len, 
                                  char *param );

int screen_get_group_property_iv( screen_group_t grp, 
                                  int pname, 
                                  int *param );

int screen_get_group_property_llv( screen_group_t grp, 
                                   int pname, 
                                   long long *param );

int screen_get_group_property_pv( screen_group_t grp, 
                                  int pname, 
                                  void **param );

Arguments:

grp
The screen_group_t instance for which to query the property.
pname
The name of the property whose value is requested. The properties that can be queried with this function are:
SCREEN_PROPERTY_NAME
A single integer containing the name of the window group.
SCREEN_PROPERTY_IDLE_STATE
A single integer containing the idle state of the display for windows in this group. The idle state will be 1 if the system is idle, indicating that no input was received after the idle timeout period. When the idle state is 0, an input event was received prior to the idle timeout period expiring.
SCREEN_PROPERTY_IDLE_TIMEOUT
A single integer indicating the amount of time (in seconds) after which the system will enter an idle state.
SCREEN_PROPERTY_KEYBOARD_FOCUS
A single window handle corresponding to the window that currently has keyboard focus. This query is only permitted from window manager contexts.
SCREEN_PROPERTY_USER_HANDLE
The handle that is passed to the application when events are associated with this window. param must be a buffer with enough storage for one void pointer.
len
The maximum number of bytes that can be written to param.
param
A buffer where the values will be stored.

Library

screen

Description

These functions store the current value of a group property in a user-specified array. No more than len bytes will be written. Each property must be queried with the variant corresponding to the type associated with this property. For example, SCREEN_PROPERTY_IDLE_STATE must be queried using the screen_get_group_property_iv() function. Group properties can be set with the screen_set_group_property() functions.

Returns

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

Classification

Windowing API

Safety  Value  
Interrupt handler No
Signal handler No
Thread Yes