Digital

NAME

XiePutStream − This routine transports a plane of image data, as a byte stream, from a client XieImage to a server image. 

C Format

XiePutStream(pho_id, plane, buffer, bytes, final)

C Argument Information

XiePhoto     pho_id;
unsigned long  plane;
unsigned char  ∗buffer;
unsigned long  bytes;
unsigned char  final;

RETURN VALUES

None. 

PARAMETERS

pho_idThe pho_id argument specifies the identifier of the destination image. The destination image can be either an unbound photomap, a photoflo, or a phototap. The photoflo is specified explicitly if the destination is specified as a photoflo, or implicitly if the destination image is specified as a photomap or phototap. 

planeThe plane argument specifies the source image data plane you want to transport. 

bufferThe buffer argument specifies the pointer to the source image data plane. 

bytesThe bytes argument specifies the length of the transported data stream in bytes. 

finalThe final argument is a Boolean flag that specifies whether or not the upcoming transport is the final one for the current data plane. If this is the only transport or the last transport for the plane, set the argument to True. 

DESCRIPTION

This routine transports a plane of image data, as a byte stream, from a client XieImage to a server image. You can use this routine only if you created the destination image using the XieClonePhoto or XieCreatePhoto routine. 

Prior to calling this routine, you must set up the transport parameters using the XieSetStream routine specifying the XieK_PutStream symbol for the mode argument. If you want to transport multiple data planes, call the XieSetStream and XiePutStream routines in combination for each plane. 

This routine always sends full bytes of image data. However, if you set the final argument True when sending the last of the image data, you can pad the last byte of the source image with nonimage data. 

This routine always executes immediately, even if the destination image is a photoflo. You can abort the data transport before completion using the XieAbortStream routine. 

XIE Events and Error Messages

Protocol Messages: 1 or more calls to X_iePutStream

XIE event returned: None

XieLib errors: None

XieServer errors: BadIDChoice -- Invalid identifier

BadAlloc -- Insufficient server resources

BadAccess -- Stream transport not set or the specified photoflo has been aborted

BadMatch -- The plane was not specified during set transport or the attempted transport direction is not the same as specified during set transport

Any error from a processing element within the photoflo while it is running