ilQueryClientImage(3X)
R."
NAME
ilQueryClientImage() − return information on a client image
SYNOPSIS
ilBool
ilQueryClientImage (
ilClientImage image,
ilImageInfo **pInfo,
unsigned long mustBeZero);
DESCRIPTION
ilQueryClientImage() returns information about an ilClientImage.
image identifies an image created by ilCreateClientImage().
**pInfo receives the pointer to the relevant image information. (The pointer points to data structures within the image; it must not be dereferenced after the image is destroyed.) If pointer(s) to the pixels and palette are present, they are returned, even if they have been created by the Image Library. Otherwise, the information matches the ilImageInfo data when the image was created. See ilCreateClientImage(3X) for the ilImageInfo structure description.
mustBeZero identifies a value that must be zero; this parameter is reserved for future use.
RETURN VALUE
Upon successful completion, ilQueryClientImage() returns TRUE.
ERRORS
If the call fails, context->error receives a non-zero error code.
EXAMPLE
The following example creates a client image, then queries it for the pixel buffer address.
ilContext context;
ilImageInfo infoBlock;
ilImageInfo *pClientInfo;
ilClientImage pImage;
.
.
.
infoBlock.clientPixels = FALSE;
if (!(pImage = ilCreateClientImage (context, infoBlock, 0)))
return(context->error);
if (!ilQueryClientImage(pImage, &pClientInfo, 0))
return(context->error);
AUTHOR
ilQueryClientImage() was developed by HP.
SEE ALSO
Using the Image Developer’s Kit.
Hewlett-Packard Company — Image Library: February, 1995