Signal end of stack.

Declaration:

Arguments:

hStack

The storage location of the stack handle which was previously locked by the IG_ISIS_drv_start_stack 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_stack function tells the driver that the application is done with the current stack of pages. Most scanner drivers ignore this message.

Upon receiving the ISIS message issued by IG_ISIS_drv_end_stack, the default message handler frees the stack handle, its tags, choice nodes, and userdata. If the stack has any child pages, each receives the ISIS message that would normally be issued by the IG_ISIS_drv_end_page. 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 prepare the scanner for subsequent operations. 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_stack 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:

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. Most drivers ignore this function.

See Also:

IG_ISIS_drv_end_page

IG_ISIS_drv_end_zone

IG_ISIS_drv_start_stack

IG_ISIS_drv_run_zone