screen_get_display_property_pv()

Updated: April 19, 2023

Retrieve the current value of the specified display property of type void*

Synopsis:

#include <screen/screen.h>
int screen_get_display_property_pv(screen_display_t disp,
                                   int pname,
                                   void **param)

Arguments:

disp
The handle of the display 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
The buffer where the retrieved value is stored. This buffer must be of type void*.

Library:

libscreen

Description:

Function Type: Flushing Execution

This function stores the current value of a display property in a user-provided buffer.

The values of the following properties can be retrieved using this function:

Note [1]: When retrieving this property, the function type is Immediate Execution.

Note [2]: You must be working within a privileged context of type SCREEN_DISPLAY_MANAGER_CONTEXT to be able to retrieve this property.

Returns:

0 if successful, or -1 if an error occurred (errno is set; refer to errno.h for more details).