Retrieve the current value of the specified pixmap property of type char
Synopsis:
#include <screen/screen.h>
int screen_get_pixmap_property_cv(screen_pixmap_t pix,
int pname,
int len,
char *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.
- len
- The maximum number of bytes that Screen can write to param.
- param
- The buffer where Screen stores the retrieved value (a character array that includes a terminating null character). This buffer must be an array of type char with a minimum length of len. If this user-provided buffer has insufficient space for storing the property being retrieved, Screen truncates the retrieved value and returns the character array without a terminating null character.
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:
Returns:
0 if successful, or -1 if an error occurred (errno is set; refer to errno.h for more details).