You are here: Programmers Reference > Programmer's Reference > ClipHelper Interface > GetClipAsStream method

ClipHelper.GetClipAsStream method

This method creates a new memory stream and writes the one clip to it using the ClipRegion as the input. The stream pointer is reset before returning the stream to the caller. The stream is entirely owned and managed by the caller. This method may be well-suited for simple scenarios where you have only one clip, for example, the Comments field in a single sheet document scanning application.

Using a ClipRegion allows the solution program to reuse the clip attributes defined for the current sheet in the ScanTools Plus application definition while customizing only the location and size of the form areas to clip.

Valid

See ScanEventArgs and ScanningManager Events Valid Combinations.

IDL

HRESULT GetClipAsStream(

[in] ClipRegion* ClipRegion,  

[out, retval] IStream** ppIStream); 

Input Parameters

ClipRegion

Pointer to the ClipRegion structure which defines the location of the clip.

Return Values

Stream

Pointer to the memory stream.

See also

ClipHelper.GetClipAsStream2 method

ClipHelper.GetClipAsStream3 method

ClipHelper.GetClipAsStream4 method

Capture Image Clips under Solution Control

 

 

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.