Digital

NAME

XieGetImageData − This routine transports all planes of image data from a server source image to a client XieImage. 

C Format

status = XieGetImageData(img)

C Argument Information

unsigned char  status;
XieImage     img;

RETURN VALUES

The routine returns the status of the routine execution in the status argument. The status values are:

•XieK_StreamFinal -- all data has been transported

•XieK_StreamMore -- more data is available

•XieK_StreamEmpty -- no more data currently available; try again later

•XieK_StreamError -- invalid destination image

PARAMETERS

imgThe img argument specifies the address of the XieImage structure to receive the image data. You must have created this XieImage structure using the XieGetImage routine. 

DESCRIPTION

This routine transports all planes of image data from a server source image to a client XieImage. Use this routine to transport photoflo image data that was not available when you used the XieGetImage routine. This routine always executes immediately, even when you specify a photoflo for the img argument. 

XIE Events and Error Messages

Protocol Messages: X_ieGetStream 1 or more times

X_ieAbortStream if there is an error

XIE event returned: None

XieLib errors: Reply error, BadLength

XieK_StreamError if the destination image is invalid

XieServer errors: BadIDChoice -- Invalid identifier