You are here: Programmers Reference > Programmer's Reference > SessionInfo Object > SessionInfo Object Summary

SessionInfo Object Summary

SessionInfo contains all information relevant to a scanning session. This object must be created directly via a call to CreateInstance and passed as a parameter to the Scan command. On creation, most properties have default values provided for best scanning; however, programmers can selectively modify properties for specific circumstance. All of the SessionInfo fields do not need to be specified for scanning.

Property values may be set at any time but they are validated only when scanning is initiated. Changing any of these properties during a scanning session will not affect the outcome of that session.

The alphabetic list of properties, including applicable defaults, is provided below. For complete details, see the topic specific to each property.

SessionInfo (creatable)

Property

Description

Application1

ScanTools Application Definition File

BatchNumber

long

ConfirmationSettings

long, based on L_CONFIRMATIONS_ENUM

ConversionProfile1, 2

ScanTools Conversion Profile

DataFile1, 2

ScanTools Data File

DataFileOption

L_DATA_FILE_OPTION_ENUM
DeleteDownloadedMetadata Boolean

DiscriminationMargin

L_DISCMARGIN_ENUM

DisplayScanningProgressWindow

Boolean

EditProfile1

ScanTools Edit Profile

LightSource

L_LIGHT_SOURCE_ENUM

MarkThreshold

L_MARKTHRESH_ENUM

PrintOption

long, based on L_PRINT_OPTION_ENUM

PrintPosition

long

RunNumber

long

ScoreProfile1

ScanTools Score Profile

Starting_SerialNo

long

StopAfter

long

TakePhantomClips

Boolean

1 = These properties support path and URL pointers. For example:

Example Directory URLs:

  • • http://dev.support.pearsondata.com/stp-web-app/Apps
  • • Apps
  • • /Apps
  • • file:///C:/Apps

Example File URls:

  • • http://dev.support.pearsondata.com/stp-web-app/Apps/z701.sds.bin
  • • Apps/z701.bin
  • • /Apps/z701.sds.bin
  • • file:///C:/Apps/z701.sds

2 = Un-trusted callers should not specify this property. In this case the ScanningManager.Scan method throws Permission Denied exception.

See also

How to Implement Event Driven Scanning

 

 

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

[email protected]

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.