Digital

NAME

XieAbortStream − This routine releases server transport resources and aborts any outstanding planes. 

C Format

XieAbortStream(pho_id, p_mask)

C Argument Information

XiePhoto     pho_id;
unsigned long  p_mask;

RETURN VALUES

None. 

PARAMETERS

pho_idThe pho_id argument specifies the identifier of the photoflo or a photomap or phototap bound to the photoflo. 

p_maskThe p_mask argument specifies the mask that indicates the plane whose resources you want to release from transport. The least significant bit of the mask indicates plane 0. You can use the symbol XieK_AllPlanes to release the resources for all planes. 

DESCRIPTION

This routine releases server transport resources and aborts any outstanding planes.  If pho_id is a photomap or a phototap, the routine releases server transport resources for the specified planes. If pho_id is a photoflo, the routine releases all planes of server transport resources held by an untapped source or destination hidden phototaps, or both. 

You can use the XieAbortStream routine to release server transport resources that were established using the XieSetStream, XieGetImage, and XiePutImage routines for which the mode argument symbol was XieK_DataFlo or XieK_DataMap. 

XIE Events and Error Messages

Protocol Messages: X_ieAbortStream

XIE event returned: None

XieLib errors: None

XieServer errors: BadIDChoice -- Invalid photomap identifier