Digital

NAME

XieTapFlo − This routine returns an identifier for the hidden phototap currently at the end of a photoflo. 

C Format

photo_id = XieTapFlo(flo_id, permanent)

C Argument Information

XiePhoto     photo_id;
XiePhoto     flo_id;
unsigned char  permanent;

RETURN VALUES

If you set the permanent argument True, the routine returns the new photomap identifier in the photo_id argument.  Otherwise, the routine returns the identifier of the new phototap identifier.  You can free the photomap or the phototap using the XieFreeResource routine. Phototaps are freed automatically when you free the associated photoflo. 

PARAMETERS

flo_idThe flo_id argument specifies the identifier of the photoflo, or any photomap or phototap bound to the photoflo. 

permanentThe permanent argument specifies whether or not you want to create a permanent photomap. Set the argument True to create a permanent photomap. Otherwise, the routine creates an ephemeral phototap. 

DESCRIPTION

This routine returns an identifier for the hidden phototap currently at the end of a photoflo. Use this routine when you want a temporary identifier so you can use the output of the last processing element as input to a downstream nonadjacent processing element.  Phototaps do not retain image data after photoflo execution. 

You can create a permanent photomap if you want the image data to be available after photoflo execution. This permanent photomap is available during photoflo execution for export to an X11 drawable, as input to downstream processing elements, and for transport back to the client.  It is not available for any other purpose until you free the associated photoflo. 

XIE Events and Error Messages

Protocol Messages: X_ieTapPhotoflo

XIE event returned: None

XieLib errors: None

XieServer errors: BadIDChoice -- Invalid identifier

BadAlloc -- Insufficient server resources

BadAccess -- A tap already exists