Complete and close an ISIS pipe transfer operation.
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_ISIS_drv_run_done(
HISISDRVRUN hRun
);
|
|
Arguments:
| Name | Type | Description |
| hRun | HISISDRVRUN | The handle of the "run" (zone data structure) being processed. This handle is initialized by the IG_ISIS_drv_run_start function that invoked the pipe. |
Return Value:
Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.
Supported Raster Image Formats:
This function does not process image pixels.
Example:
See IG_ISIS_drv_run_start examples.
Remarks:
IG_ISIS_drv_run_done completes a data transfer operation and invalidates the run handle that was initialized by the related IG_ISIS_drv_run_start function.
Call IG_ISIS_drv_run_done after looping on IG_ISIS_drv_run_step until all data is transferred (as indicated by IG_ISIS_drv_run_step returning IG_ISIS_ERR_ENDZONE). Or, call IG_ISIS_drv_run_done prior to IG_ISIS_ERR_ENDZONE to cancel the run.
IG_ISIS_drv_run_done is one of the basic components of IG_ISIS_drv_run_zone. It is the last of four functions that when used together invoke an ISIS pipe. Invoking a pipe starts a scanning, reading, writing, compression, or other operation as defined by the drivers linked in the pipe.