xosd_destroy - Destroy an XOSD object
Contents
Arguments
osd The object to destroy.
Bugs
There are no known bugs with xosd_destroy. Bug reports can be sent to <xosd@ignavus.net>.
Description
xosd_destroy destroys an XOSD object freeing up any memory used. The osd object must have been created by
xosd_create(3xosd).
xosd_destroy is not intended to be used on its own, but functions as a helper within the display_info
tool.
Environment
char*xosd_error
A string to a text string describing the error, if one occurred.
History
The xosd_destroy function first appeared in version 2.0 of the XOSD library, replacing the now depricated
xosd_uninit function.
Name
xosd_destroy - Destroy an XOSD object
Return Value
On success 1 is returned, otherwise 0 is returned and xosd_error is set to indicate the reason for the
error.
See Also
xosd_create(3). XOSD_DESTROY(3)
Synopsis
#include <xosd.h>
int xosd_destroy (xosd *osd);
