NAME

ilEmptyPipe() − empty an Image Library pipe

SYNOPSIS

ilBool
ilEmptyPipe (

ilPipe pipe);

DESCRIPTION

ilEmptyPipe() empties an Image Library pipe, removing all elements it contains.  The pipe state is set to IL_PIPE_EMPTY.  If the pipe is executing, which is indicated when IL_EXECUTE_AGAIN is returned by ilExecutePipe(), the pipe execution is aborted.  The pipe is freed when you use ilDestroyObject() on it or when you use ilDestroyContext() on the associated context. 

pipe identifies an ilPipe structure created by ilCreatePipe(). 

RETURN VALUE

Upon successful completion, ilEmptyPipe() returns TRUE. 

EXAMPLE

The following example empties a pipe if the specified conversion is not possible. 

ilContext context;

ilPipe pipe;
.
.
.

if (!ilConvert (pipe, ...)) {

if (context->error == IL_ERROR_CANT_CONVERT) {

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

}
else

return (context->error);

}

ERRORS

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

AUTHOR

ilEmptyPipe() was developed by HP. 

SEE ALSO

ilCreatePipe(3X), ilDestroyObject(3X), ilDestroyContext(3X), ilExecutePipe(3X), ilAbortPipe(3X). 

Using the Image Developer’s Kit.

Hewlett-Packard Company  —  Image Library: February, 1995