DTWAIN_FrameCreate

Top  Previous  Next

The DTWAIN_FrameCreate creates a DTWAIN_FRAME.

 

DTWAIN_FRAME DTWAIN_FrameCreate (

DTWAIN_SOURCE

Left,

DTWAIN_FLOAT

Top,

DTWAIN_FLOAT

Right,

DTWAIN_FLOAT

Bottom );

 

Parameters

Left

Left (x) value of the DTWAIN_FRAME.

 

Top

Top (y) value of DTWAIN_FRAME.

 

Right

Right (x) value of DTWAIN_FRAME

 

Bottom

Bottom (y) value of DTWAIN_FRAME

 

Return Values

If the function succeeds, a new DTWAIN_FRAME is returned.  Otherwise, NULL is returned.

 

Comments

The DTWAIN_FrameCreate function returns a new DTWAIN_FRAME.  The DTWAIN_FRAME is to be used to set or get capabilities that require a TW_FRAME.  A DTWAIN_FRAME describes a rectangular region defined by the following (x, y) coordinates:  (Left, Top) as the upper left corner of the rectangle, and (Right, Bottom) as the lower right corner of the rectangle.

 

The returned DTWAIN_FRAME is valid until DTWAIN_FrameDestroy or DTWAIN_SysDestroy is called.

 

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

DTWAIN_FRAME Functions