Signal end of zone.
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_ISIS_drv_end_zone(
HISISDRV hZone);
|
|
Arguments:
| Name | Type | Description |
| hZone | HISISDRV | The storage location of the zone handle which was previously locked by the IG_ISIS_drv_start_zone function. |
Return Value:
Error count.
Supported Raster Image Formats:
This function does not process image pixels.
Example:
See IG_ISIS_drv_end_page.
Remarks:
The IG_ISIS_drv_end_zone function tells the driver that the application is done with the current zone. The application may call this function before the scanner is done processing a zone. If it does so, the remaining zone data is discarded. Upon receiving the message issued by this function, a scanner may begin to reset itself and prepare for the next operation.
Upon receiving the ISIS message issued by IG_ISIS_drv_end_zone, the default message handler frees the zone handle, its tags, choice nodes, and userdata. If the userdata points to any additional memory, the driver must free this memory. The driver also may need to do some additional work to reset the scanner if it has not yet finished scanning. A scanner driver should make sure that it calls the default message handler so that the tags, choice nodes, and userdata get properly freed.
IG_ISIS_drv_end_zone is one of several hierarchical data transfer functions that are called automatically by the IG_ISIS_drv_run_zone function. The hierarchy of data transfer functions is:
| Copy Code |
|
|---|---|
IG_ISIS_drv_start_stack
IG_ISIS_drv_start_page
IG_ISIS_drv_start_zone
IG_ISIS_drv_forward
IG_ISIS_drv_start_data
IG_ISIS_drv_put_data
IG_ISIS_drv_end_zone
IG_ISIS_drv_end_page
IG_ISIS_drv_end_stack
|
|
Applications should call IG_ISIS_drv_end_zone after receiving an End Zone condition from a IG_ISIS_drv_put_data call.
Most applications can use IG_ISIS_drv_run_zone to automatically invoke the IG_ISIS_drv... functions required to acquire and process an image. IG_ISIS_drv_run_zone will call IG_ISIS_drv_start_stack|Page|Zone and IG_ISIS_drv_end_stack|Page|Zone as necessary to process documents, but will not allow a high degree of control over the individual stack, page, and zone levels. If your application needs more control over the individual levels of processing stacks, pages, and zones, then it can call the separate IG_ISIS_drv... functions as necessary.