screen_get_session_property_cv()

Retrieve the current value of the specified session property of type char

Synopsis:

#include <screen/screen.h>
int screen_get_session_property_cv(screen_session_t ssn,
                                   int pname,
                                   int len,
                                   char *param)

Arguments:

ssn
The handle of the session 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) is stored. This buffer must be an array of type char with a minimum length of len. If the user-provided buffer has insufficient space for storing the buffer property being retrieved, the data is truncated (not necessarily with a terminating null character).

Library:

libscreen

Description:

Function Type: Flushing Execution

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

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

Returns:

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