.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "XOSD_DESTROY" 3xosd "" "" ""
.SH NAME
xosd_destroy \- Destroy an XOSD object
.SH "SYNOPSIS"
.ad l
.hy 0

#include <xosd.h>
.sp
.HP 18
int\ \fBxosd_destroy\fR\ (xosd\ *\fIosd\fR);
.ad
.hy

.SH "DESCRIPTION"

.PP
\fBxosd_destroy\fR destroys an XOSD object freeing up any memory used. The \fIosd\fR object must have been created by \fBxosd_create\fR(3xosd).

.SH "ARGUMENTS"

.TP
\fIosd\fR
The object to destroy.

.SH "RETURN VALUE"

.PP
On success 1 is returned, otherwise 0 is returned and \fIxosd_error\fR is set to indicate the reason for the error.

.SH "ENVIRONMENT"

.TP
\fIchar *xosd_error\fR
A string to a text string describing the error, if one occurred.

.SH "HISTORY"

.PP
The \fBxosd_destroy\fR function first appeared in version 2.0 of the XOSD library, replacing the now depricated \fBxosd_uninit\fR function.

.SH "AUTHORS"

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

.SH "BUGS"

.PP
There are no known bugs with \fBxosd_destroy\fR.
Bug reports can be files on http://sourceforge.net/projects/libxosd/.

.SH "SEE ALSO"

.PP
 \fBxosd_create\fR(3xosd)