NAME

ilReadImage() − read a pipe image from a client or internal image

SYNOPSIS

ilBool
ilReadImage (

ilPipe pipe,

ilObject image);

DESCRIPTION

ilReadImage() reads a pipe image from a client or internal image and passes it to the next element in the pipe. 

Note that when reading compressed images that are written to by a pipe formed with ilWriteImage(), it is more efficient to call ilWriteImage() before ilReadImage() on the same image. 

pipe is a pipe created by ilCreatePipe(). 

image identifies an ilClientImage structure (returned by ilCreateClientImage() or an ilInternalImage structure (returned by ilCreateInternalImage ). 

RETURN VALUE

Upon successful completion, ilReadImage() returns TRUE. 

ERRORS

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

EXAMPLE

The following example reads the client image into a pipe. 

ilContext context;

ilPipe pipe;

ilClientImage image;
.
.
.

if (!ilReadImage(pipe, (ilObject) image))
return (context->error);

AUTHOR

ilReadImage() was developed by HP. 

SEE ALSO

ilListFileImages(3X), ilConnectFile(3X). 

Using the Image Developer’s Kit.

Hewlett-Packard Company  —  Image Library: February, 1995