Dynamsoft Home|Product Home

GetImageLayout Method

Description

Retrieves the left, top, right, and bottom sides of the image layout rectangle for the current Data Source.

Syntax

Boolean ObjectName. GetImageLayout(Float *pLeft,  Float *pTop, Float *pRight, Float *pBottom)

Parameters

Float *pLeft: the floating point number for the left side of the image layout rectangle. 

Float *pTop: the floating point number for the top side of the image layout rectangle. 

Float *pRight: the floating point number for the right side of the image layout rectangle. 

Float *pBottom: the floating point number for the bottom side of the image layout rectangle. 

Return value

Boolean.

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 image layout rectangle defines what portion of the Data Source's scanning area is acquired.

See also

GetDefaultImageLayout(), ResetImageLayout(), SetImageLayout()