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

ScanningManager.Scan method

Initiates a scanning session and returns immediately, after which the caller will be notified of significant events via event handlers. All information relevant to an event will be provided to the caller as event parameters as explained in ScanEventArgs Interface Summary. The real work of the program will be done in the code that handles the events.

This method returns an error if a scanning session or diagnostic session is in progress.

The Scan method maintains a reference to the passed SessionInfo object and releases it following the SessionComplete event. If an error occurs before the Scan method returns, the reference is not even made.

The first time you call Scan, remote metadata is downloaded as necessary and cached. Subsequent calls to Scan do not have to incur this overhead provided you do not alter the SessionInfo object between calls to Scan.

If there is a problem feeding or reading a sheet, it will present the Scanner Error Dialog; user may choose to fix the problem or stop scanning.

Valid

See Scanning Manager States and Valid Properties/Methods

See ScanningManager Events and Valid Properties/Methods

IDL

HRESULT Scan([in] ISessionInfo* pVal, [in, L_PORT_ENUM Port);

Input Parameters

pVal

Pointer to SessionInfo object that contains information to use for this scanning session.

See SessionInfo Object

Port

Identifies the port with the scanner on which to begin scanning. Port is of type L_PORT_ENUM. See L_PORT_ENUM for all values.

Exceptions

Returns an error if a scanning session or diagnostic session is in progress.

Scanning Services Exceptions

Permission Denied exception

License related exceptions:

URL services not licensed

XML services not licensed

URL or Path Not Resolved exception if the metadata location cannot be resolved. Perhaps the metadata location is incomplete or invalid

For un-trusted callers only:

See also

ScanningManagerEvents Summary

How to Implement Event Driven Scanning

How to Manage the Connection to ScanTools Plus Link Runtime

 

 

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.