screen_get_context_property_cv()

Retrieve the current value of the specified context property of type char.

Synopsis:

#include <screen/screen.h>
 
int screen_get_context_property_cv(screen_context_t ctx,
                                   int pname,
                                   int len,
                                   char *param)

Arguments:

ctx

The handle of the context 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.

len

The maximum number of bytes that can be written to param.

param

The buffer where the retrieved value(s) will be stored. This buffer must be an array of type char with a maximum length of len.

Library:

libscreen

Description:

Function Type: Flushing Execution

This function stores the current value of a context property in a user-provided buffer. No more than len bytes of the specified type will be written.

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). Note that the error may also have been caused by any delayed execution function that's just been flushed.