screen_get_window_property_pv()

Graphics and Screen4.0 (8.x)Screen Graphics Subsystem Developer's GuideAPIProgrammingUtilities

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

Synopsis:

#include <screen/screen.h>
int screen_get_window_property_pv(screen_window_t win,
                                  int pname,
                                  void **param)

Arguments:

win
handle of the window whose property is being queried.
pname
The name of the property whose value is being queried. The properties available for querying are of type Screen property types.
param
A pointer to a buffer containing the new value(s). This buffer must be of type void*.

Library:

libscreen

Description:

Function Type: Flushing Execution

This function retrieves the value(s) of a window property and stores them in a user-provided buffer. The values of the following properties can be queried using this function:

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

Note [2]: When you're retrieving this property, Screen locally allocates resources to track the object that you retrieve. Therefore, you must call the appropriate screen_destroy_*() function to free these 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: