NAME

ilDestroyObject − destroy an Image Library object

SYNOPSIS

ilBool
ilDestroyObject (

ilObject object);

DESCRIPTION

ilDestroyObject() destroys an ilObject data structure, which makes it unavailable for further use and frees all associated resources.  An object can also be destroyed by using ilDestroyContext() on the context associated with the object. 

object identifies any structure of the data type ilObject, such as an ilPipe, ilFile, ilInternalImage, ilClientImage, or an ilXWC. 

RETURN VALUE

Upon successful completion, ilDestroyObject() returns TRUE. 

ERRORS

If the call fails, context->error receives a non-zero error code. 

EXAMPLE

The following example destroys a pipe data structure. 

ilContext context;

ilPipe pipe;
.
.
.

if (!ilDestroyObject(pipe)) return (context->error);

AUTHOR

ilDestroyObject was developed by HP. 

SEE ALSO

ilCreateClientImage(3X), ilCreateInternalImage(3X), ilCreatePipe(3X), ilConnectFile(3X), ilCreateXWC(3X), ilDestroyContext(3X). 

Using the Image Developer’s Kit.

Hewlett-Packard Company  —  Image Library: February, 1995