Screen library referencePixmaps (screen.h) Parent topic: Pixmaps (screen.h)

screen_get_pixmap_property_pv()

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

Synopsis:

#include <screen/screen.h>
int screen_get_pixmap_property_pv(screen_pixmap_t pix,
                                  int pname,
                                  void **param)

Arguments:

pix
The handle of the pixmap 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 of pixmap property from 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 group that you retrieve. Therefore, you must call screen_destroy_group() to free these resources when you no longer need to use the group in your local context.

Returns:

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

Parent topic: Pixmaps (screen.h)