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

SessionInfo.DataFileOption property

Read-Write Property.

Type: L_DATA_FILE_OPTION_ENUM

Determines the action to be taken if the specified data file and master clip (.tif) file used for scanning already exists. This is the same as the settings in the ScanTools Plus Scanning Options dialog, File Names, Data and Output Conversion Files, Append, Replace, Replace at S/N. Validation is performed when scanning is initiated.

ScanTools Plus software uses the following rules:

IDL

propget, HRESULT DataFileOption([out, retval] L_DATA_FILE_OPTION_ENUM *pVal);

propput, HRESULT DataFileOption([in] L_DATA_FILE_OPTION_ENUM newVal);

Values

L_DATA_FILE_OPTION_APPEND (default)

If the *.dat file exists and the applications match, new data will be written at the end of the data file with the first Serial number written being one greater than the highest serial in the data file. The SerialNo parameter in the session parameters will be ignored.

If the *.dat file exists and if the dat file's application differs from the application to be used for this session, Scan method will return an error (IDS_DataFileNotForApp).

The same action applies if a master clip file (*.tif) exists, and clipping is being performed.

L_DATA_FILE_OPTION_NOFILES

If the solution program indicates that Link must not create/update any data file, master tiff file, ICR extension data file or conversion output file. This scanning session creates no file output for scanned data and images. Use this to implement a “zero data footprint” solution or to create file output in a custom way. Application, edit profile and score profile can be specified.

Implement an optical marks-only scanning session by not specifying the application definition. If you are not specifying an application definition, you should also not specify any profile. The OMR is not resolved to ASCII data. Take this route when you are performing custom resolution perhaps on a remote server or for international markets.

L_DATA_FILE_OPTION_REPLACE

Will always replace the data file when starting the Scan method even if the data file is not for the application whose application number is specified in the session parameters. Deletes the data file if it exists and starts with the serial number specified in the Starting_SerialNo property.

The same action applies if a master clip file (*.tif) exists, and clipping is being performed.

L_DATA_FILE_OPTION_REPLACE_ATSERNO

If *.dat file exists and the applications match, and:

  • If the starting serial number specified in the Starting_SerialNo property is in the .dat file, new data scanned replaces (writes over) old data beginning at that serial number. See also Starting_SerialNo property
  • If a starting serial number is specified and it does not correspond to a record in the .dat file, Scan will return an error.
  • If a starting serial number is not specified (0), the serial number of the last record is used as the starting number for the first document in the session.

If *.dat file exists and if the *.dat file's application differs from the application to be used for this session, Scan will return an error (IDS_DataFileNotForApp).

The same action applies if a master clip file (*.tif) exists, and clipping is being performed.

Exceptions

Scanning Services Exceptions

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

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.