ilCreatePipe(3X)

NAME

ilCreatePipe() − create an empty Image Library pipe

SYNOPSIS

ilPipe
ilCreatePipe (

ilContext context,

unsigned long mustBeZero);

DESCRIPTION

ilCreatePipe() creates an empty Image Library pipe and returns it as an ilPipe data structure. The pipe is empty until a producer pipe element, such as ilReadFileImage() or ilReadImage is added, resulting in a forming pipe. Various filters, such as ilCompress() or ilScale(), may be added to a forming pipe. Finally a consumer pipe element such as ilWriteFile() must be added to the forming pipe to make a complete pipe. A completed pipe may be executed using ilExecutePipe().

To find out the state of the pipe, use ilQueryPipe(). To empty a pipe, use ilEmptyPipe().

The pipe is freed when you use ilDestroyObject() on it or when you use ilDestroyContext() on the associated context.

context identifies a context created by IL_CREATE_CONTEXT().

mustBeZero identifies a value that must be zero; this parameter is reserved for future use.

RETURN VALUE

Upon successful completion, ilCreatePipe() returns an ilPipe data structure.

ERRORS

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

EXAMPLE

The following example creates an Image Library pipe

ilContext context;

ilPipe pipe;
.
.
.

if (!(pipe = ilCreatePipe(context, 0))) return (context->error);

AUTHOR

ilCreatePipe() was developed by HP.

Museum

Related Articles