Screen library referenceSessions (screen.h) Parent topic: Sessions (screen.h)

screen_get_session_property_pv()

Retrieve the current value of the specified session property of type void*

Synopsis:

#include <screen/screen.h>
int screen_get_session_property_pv(screen_session_t ssn,
                                   int pname,
                                   void **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
The buffer where the retrieved value(s) is stored. This buffer must be of type void*.

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 you're retrieving this property, the function type is Immediate Execution.

Note [2]: When you're retrieving this property, Screen locally allocates resources to track the window that you retrieve. Therefore, you must call screen_destroy_window() to free these resources when you no longer need to use the window in your local context.

Returns:

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

Parent topic: Sessions (screen.h)