screen_get_session_property_fv()

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

Synopsis:

#include <screen/screen.h>
int screen_get_session_property_fv(screen_session_t ssn, int pname, float *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.
param
A pointer to a buffer where this function stores the retrieved value(s). This buffer must be of type float.

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:

Note [1]: When retrieving this property, the function type is Immediate Execution.

Returns:

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

Page updated: