screen_unref_stream()

Remove a reference from a specified stream

Synopsis:

#include <screen/screen.h>

int screen_unref_stream(screen_stream_t stream)

Arguments:

stream: The handle of the stream for which the reference is to be removed.

Library:

libscreen

Description:

Function Type: Immediate Execution

This function removes a reference to a stream. If the stream and its buffers haven't been destroyed yet, the effect of screen_unref_stream() is simply to decrease a reference count. If the stream or its buffers were destroyed while still being referenced, screen_unref_stream() causes the stream and/or its buffers to be destroyed when the reference count reaches zero.

Returns:

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