screen_get_buffer_property_pv()

Retrieve the current value of the specified buffer property of type void*.

Synopsis:

#include <screen/screen.h>
 
int screen_get_buffer_property_pv(screen_buffer_t buf,
                                  int pname,
                                  void **param)

Arguments:

buf

The handle of the buffer 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(s) will be stored. This buffer must be of type void*.

Library:

libscreen

Description:

Function Type: Immediate Execution

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

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

Returns:

0 if a query was successful and the value(s) of the property are stored in param, or -1 if an error occurred (errno is set; refer to /usr/include/errno.h for more details).