Screen library referenceStreams (screen.h) Parent topic: Streams (screen.h)

screen_get_stream_property_pv()

Updated: October 28, 2024

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

Synopsis:

#include <screen/screen.h>
int screen_get_stream_property_pv(screen_stream_t stream,
                                  int pname,
                                  void **param)

Arguments:

stream
handle of the stream whose property is being queried.
pname
The name of the property whose value is being queried. The properties available for querying 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 void*.

Library:

libscreen

Description:

Function Type: Flushing Execution

This function retrieves the value(s) of a stream property and stores them in a user-provided buffer. The values of the following properties can be queried 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).

Parent topic: Streams (screen.h)