xosd_destroy man page

xosd_destroy — Destroy an XOSD object

Synopsis

#include <xosd.h>

int xosd_destroy (xosd *osd);

Description

xosd_destroy destroys an XOSD object freeing up any memory used. The osd object must have been created by xosd_create(3xosd).

Arguments

osd
The object to destroy.

Return Value

On success 1 is returned, otherwise 0 is returned and xosd_error is set to indicate the reason for the error.

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.

Authors

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

Bugs

There are no known bugs with xosd_destroy. Bug reports can be sent to <xosd@ignavus.net>.

See Also

xosd_create(3xosd)

Info