NAME

ilAbortPipe() − cancel execution of an Image Library pipe

SYNOPSIS

ilBool
ilAbortPipe (

ilPipe pipe);

DESCRIPTION

ilAbortPipe() cancels execution of a pipe and changes the execution status to IL_PIPE_COMPLETE.  If used on a non-executing pipe, ilAbortPipe() returns no error and the execution status is unchanged. 

pipe identifies an ilPipe structure created by ilCreatePipe(). 

RETURN VALUE

Upon successful completion, ilAbortPipe() returns TRUE. 

ERRORS

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

EXAMPLE

The following example aborts the execution of a pipe, if a condition is set. 

ilPipe pipe;

int status;
.
.
.

do {

if (testAbortCondition()) {

ilAbortPipe( pipe );
break;
}

status = ilExecutePipe(pipe, 1);

} while (status == IL_EXECUTE_AGAIN);
if (context->error) return (context->error);

AUTHOR

ilAbortPipe() was developed by HP. 

SEE ALSO

ilCreatePipe(3X), ilExecutePipe(3X). 

Using the Image Developer’s Kit.

Hewlett-Packard Company  —  Image Library: February, 1995