Prev   Next

Name

xosd_set_timeout — Change the time before the XOSD window is hidden

Synopsis

#include <xosd.h>

int xosd_set_timeout(xosd *osd, int timeout);

Description

By default, an XOSD window is never removed from the display unless xosd_hide(3xosd) is called. Calling xosd_set_timeout changes this behaviour so the window is automatically hidden timeout seconds after xosd_display(3xosd) is called.

Arguments

osd

The XOSD window to change.

timeout

The number of seconds that should pass before the XOSD window is removed from the display. If timeout is set to -1 then the XOSD window is never removed from the display unless xosd_hide(3xosd) is called.

Return Value

On success, a zero is returned. On error, -1 is returned and xosd_error is set to indicate the reason for the error.

Environment

char *xosd_error

A string describing the error, if one occurred.

Authors

The XOSD library was originally written by André Renaud, and is currently maintained by Tim Wright. This document was written by Michael JasonSmith.

See Also

xosd_create(3xosd), xosd_hide(3xosd), xosd_display(3xosd)

Prev Up Next
 Home