Return a pointer to the current run's handle.

Declaration:

AT_ERRCOUNT ACCUAPI IG_ISIS_drv_run_zone(
        HISISDRVRUN hRun
);

Arguments:

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:

Depends on the scanner driver.

Example:

See IG_ISIS_drv_run_start examples.

Remarks:

IG_ISIS_drv_run_zone (not to be confused with the IG_ISIS_run_zone function) returns a pointer to the current run handle that was initialized by IG_ISIS_drv_run_start. This allows you to use IG_ISIS_tag_set... functions to set output parameters when the ISIS pipe's head (first) driver is not a data generator.

For example, when the head driver is a compression driver and you need to set image width, you would use the IG_ISIS_drv_run_zone function to get the run handle.

Call IG_ISIS_drv_run_zone after calling IG_ISIS_drv_run_start and before calling IG_ISIS_drv_run_step. IG_ISIS_drv_run_zone gives you the run handle which you can then pass as a parameter in one or more IG_ISIS_tag_set... functions to set as many parameters as needed. After setting all necessary parameters, loop on IG_ISIS_drv_run_step until all data is transferred (as indicated by IG_ISIS_drv_run_step returning IG_ISIS_ERR_ENDZONE).

The IG_ISIS_drv_run_zone function is one 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. IG_ISIS_drv_run_zonereturns a pointer to the current run zone handle that was initialized by the related IG_ISIS_drv_run_start function.

See Also:

IG_ISIS_drv_run_done

IG_ISIS_drv_run_start

IG_ISIS_drv_run_step

IG_ISIS_drv_run_zone