NAME

ilQueryInternalImage() − obtain information about an internal image

SYNOPSIS

ilBool
ilQueryInternalImage (

ilInternalImage image,

long *pWidth,

long *pHeight,

ilImageDes *pImageDes,

unsigned long mustBeZero);

DESCRIPTION

ilQueryInternalImage() obtains information about an image created by ilCreateInternalImage(). 

image identifies the ilInternalImage being queried. 

*pWidth receives the image width, unless the application sets pWidth to NULL. 

*pHeight receives the image height, unless the application sets pHeight to NULL. 

*pImageDes receives information from ilImageDes, the structure that defines the image attributes, unless the application sets pImageDes to NULL. 

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

RETURN VALUE

Upon successful completion, ilQueryInternalImage() returns TRUE. 

ERRORS

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

EXAMPLE

The following example queries an internal image for its width and height only. 

ilContext context

ilInternalImage image;

long width;

long height;
.
.
.

if (!ilQueryInternalImage(image, &width, &height, NULL, 0))

return(context->error);

AUTHOR

ilQueryInternalImage() was developed by HP. 

SEE ALSO

ilCreateInternalImage(3X). 

Using the Image Developer’s Kit.

Hewlett-Packard Company  —  Image Library: February, 1995