Name

xosd_show — Make the XOSD window visible

Synopsis

#include <xosd.h>

int xosd_show(xosd *osd);

Description

xosd_show is called to redisplay data that has been previously displayed using xosd_display(3xosd). The display will remain displayed until the timeout limit, set by calling xosd_set_timeout(3xosd), is reached. The display can be explicitly hidden by calling xosd_hide(3xosd).

Arguments

osd

The XOSD window to show.

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_display(3xosd), xosd_set_timeout(3xosd), xosd_hide(3xosd).