Set the value of the specified event property of type char
Synopsis:
#include <screen/screen.h>
int screen_set_event_property_cv(screen_event_t ev,
int pname,
int len,
const char *param)
Arguments:
- ev
- The handle of the event whose property is being set. Ensure that you've set the SCREEN_PROPERTY_TYPE to one of the valid Screen property types prior to calling this function.
- 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 an event property from a user-provided buffer. The list of properties that can be set per event type are listed as follows:
Returns:
0 if successful, or -1 if an error occurred (errno is set; refer to errno.h for more details).