TWAIN ActiveX/Plug-in Windows/Mac HTTP Control/SDK

CapGetFrameLeft Method

Description

Returns the value (in ICAP_UNITS) of the left-most edge of the specified frame.

Support information

ActiveX Edition Plug-in Edition Mac Edition
Since V2.0 Since V4.0 Since V6.4

Syntax

Single ObjectName. CapGetFrameLeft(Integer Index)

Parameters

Integer Index: specifies the value of which frame to get. The index is 0-based.

Return value

The data type of the return value is Single (float).

TRUE indicates success. FALSE indicates failure.

When an error occurs and IfThrowException property is TRUE, an exception will be thrown.

When FALSE is returned or an exception is thrown, check ErrorCode property and ErrorString property for error information.

Remarks

The unit of CapGetFrameLeft() is determined by ICAP_UNITS capability.

The default unit is assumed to be "inches" unless it has been otherwise negotiated between the application and source.

CapGetFrameLeft() is different from ImageLayoutFrameLeft property. 

CapGetFrameLeft() is part of ICAP_FRAMES capability negotiation. It can return the value of any frames in a page.

ImageLayoutFrameleft property only returns the value of the current frame which is being transferred. It is valid only in OnPreTransfer and OnPostTransfer event.

See also

CapGetFrameTop(), CapGetFrameRight(), CapGetFrameBottom(), CapSetFrame()

Sample

Refer to How to negotiate ICAP_FRAMES




TWAIN ActiveX | TWAIN Plug-in | TWAIN Control | TWAIN SDK | Scanner COM
Software Configuration Management | Version Control | Source Control
Copyright © 2012 Dynamsoft Corporation. All Rights Reserved.