xosd_wait_until_no

Prev		Next

Name

xosd_wait_until_no_display — Suspend execution until the XOSD window is hidden

Synopsis

#include <xosd.h>

int xosd_wait_until_no_display(xosd *osd);

Description

xosd_wait_until_no_display suspends execution of the calling program until the XOSD window is no-longer displayed because a timeout, set by xosd_set_timeout(3xosd), has expired. This behavior can be emulated by removing the timeout for the window, calling xosd_show(3xosd), sleeping, and calling xosd_hide(3xosd).

Arguments

osd: The XOSD window that is being waited on.

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.

Bugs

There are no known bugs with xosd_wait_until_no_display. However, the calling program can deadlock by removing the timeout and calling xosd_wait_until_no_display. Bug reports can be sent to <xosd@ignavus.net>.

Authors

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