You are here: Programmers Reference > Programmer's Reference > ScanningManager > Stop

ScanningManager.Stop method

A request to ScanningManager.Stop method ends the scanning session. This method overrides the SessionInfo.StopAfter property. The ScanningManager.Stop method can be called at any point during the scanning session. The scanner stops scanning and the SessionComplete event is raised.

L_WHENTOSTOP_EOFSHEET Input Parameter

When the L_WHENTOSTOP_EOFSHEET input parameter is used when the current document is a single sheet, both sides are completed and the record is written to the output file before the termination takes effect. If the current document is a booklet, the current sheet is completed, any remaining sheets are not completed, and the record is not written to the output file. However, if invoked while on the last page of a booklet, then scanning is completed and the record is written to the output file.

NOTE: When scanning on an OpScan iNSIGHT 2 or 4 scanner, if a Stop is issued at the Clip event or any event after the Clip event, an extra sheet will be fed.

L_WHENTOSTOP_EOFDOC Input Parameter

When the L_WHENTOSTOP_EOFDOC input parameter is used, the current document is completed and the record is written to the output file.

NOTE: When scanning on an iNSIGHT 2 or 4 scanner, if a Stop is issued at the Clip event or any event after the Clip event on the last sheet of the document, an extra sheet will be fed.

Valid

See Scanning Manager States and Valid Properties/Methods

See ScanningManager Events and Valid Properties/Methods

IDL

HRESULT Stop([in, L_WHENTOSTOP_ENUM When)

Input Parameters

When

Indicates how soon to stop scanning.

L_WHENTOSTOP_EOFSHEET

Stop at the end of this sheet.

L_WHENTOSTOP_EOFDOC

Stop at the end of this document.

Exceptions

Scanning Services Exceptions

See also

How to Implement Event Driven Scanning

How to Handle General Errors

 

 

See Help on Help for additional information on using this help file.

See Scantron Technical Support for additional information on technical support and training options.

See the ScanTools Suite System Requirements for further details on hardware and software requirements.

ScanTools is a suite of products; the specific information you want may appear in the help for a different module. If you don't find what you're looking for here, try one of the following:

 

Scantron Corporation

Customer Service (forms, products, and services):

1-800-SCANTRON (722-6876)

www.scantron.com

Technical Support:

1-800-445-3141

support@scantron.com

Copyright © 1998-2012 Scantron Corporation. All rights reserved. Use permitted only under license. www.scantron.com. No part of the Help or user guides may be reproduced in any form, or by any means, without express permission from Scantron Corporation.

LINKS TO THIRD PARTY SITES

This help system may contain links to third party websites ("Linked Sites"). The Linked Sites are not under the control of Scantron and Scantron is not responsible for the content of any Linked Site, including without limitation any link contained in a Linked Site or any changes or modifications to a Linked Site. Scantron is not responsible for web casting or any other form of transmission received from any Linked Site. Scantron provides Users with the ability to link the Assessment System to the Linked Sites as a convenience to you, and the inclusion of any link does not imply endorsement by Scantron of the Linked Site or any association with its operators.