screen_set_buffer_property_cv()

Updated: April 19, 2023

Set the value of the specified buffer property of type char

Synopsis:

#include <screen/screen.h>
int screen_set_buffer_property_cv(screen_buffer_t buf,
                                  int pname,
                                  int len,
                                  const char *param)

Arguments:

buf
The handle of the buffer whose property is to be set. The buffer must have been created with the function screen_create_buffer().
pname
The name of the property whose value is being set. The properties that you can set are of type Screen property types.
len
The size (including a terminating null character) of param. Screen reads from param until it encounters a null character (\0), or until len number of bytes is reached. Ensure that len doesn't exceed the maximum size that Screen allows for the property specified by pname.
param
A pointer to a character array containing the new property value. This array must have a minimum length of len.

Library:

libscreen

Description:

Function Type: Immediate Execution

This function sets the value of a buffer property from a user-provided buffer.

Currently there are no buffer properties that can be set using this function.

Returns:

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