DTWAIN_FrameGetAllString
|
The DTWAIN_FrameGetAll function gets all the coordinate values defined by the DTWAIN_FRAME
DTWAIN_BOOL DTWAIN_FrameGetAllString (
Parameters Frame A valid DTWAIN_FRAME type.
pLeft Address of character buffer that will be used to store left x value. To ignore this value, this should be NULL pTop Address of character buffer that will be used to store top y value. To ignore this value, this should be NULL
pRight Address of character buffer that will be used to store right x value. To ignore this value, this should be NULL.
pBottom Address of character buffer that will be used to store bottom y value. To ignore this value, this should be NULL.
Return Values If the function succeeds, TRUE is returned. If the function fails FALSE is returned.
Character specific version
Comments The DTWAIN_FrameGetAllString function works exactly the same way as DTWAIN_FrameGetAll, with the exception of the lpLeft, pTop, pRight, and pBottom parameters, which point to string buffer that will be filled on return with the left, top, right, and bottom components of the frame, respectively
The LPTSTR arguments must point to a buffer large enough to hold the necessary string information, or must be NULL if the value is to be ignored. The string information will not exceed 255 characters.
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.
TWAIN State Transitions None.
Prerequisite Function Call(s)
See Also |