You are here: Programmers Reference > Programmer's Reference > Clip Interface > WriteToFile method

Clip.WriteToFile method

This method writes the clip to the specified file. The file must be empty or TIFF/JPEG formatted. The clip is JPEG formatted if you requested JPEG compression (ClipCompressionMethod.cpmJPEG) and for all other compressions, it is TIFF formatted. The file is closed on exit from this method. File input/output requires write permissions to the directory and/or file specified. Performance could be impacted if you are appending to an existing file especially across a network.

When writing a TIFF formatted clip to an empty file, a standard TIFF header is first written followed by the clip itself. When writing a TIFF formatted clip to a file that already has a TIFF formatted image, the method appends the clip that is currently being taken.

When writing a JPEG formatted clip, the file must be empty, or an exception will result.

A typical use of this method is creating single-page or multi-page tiff images for each document.

IDL

HRESULT WriteToFile[in] BSTR ImageFile);

Input Parameters

ImageFile

String. File name used for the image clip.

NOTE: You must use the following image file extensions:

  • JPEG compressed files: .JPG
  • All other compression methods: .TIF

See also

Clip.TransformOnWrite property

 

 

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.