SetGuideHRC
2.0
Sets a guide
structure into an HRC object.
int SetGuideHRC( HRC hrc, LPGUIDE lpguide,
UINT nFirstVisible )
Parameters
hrc
Handle to the
HRC object.
lpguide
Pointer to a GUIDE structure, or NULL. All
coordinates are in screen coordinates.
nFirstVisible
For boxed
controls, nFirstVisible refers to the first visible box (leftmost and
topmost for left-right, top-down languages like English). For other controls,
this is the first visible character position (leftmost for English) in a
single-line control, and the first visible line (topmost for English) in
multiline controls.
Return Value
Returns
HRCR_OK if successful; otherwise, returns one of the following negative values:
|
Constant |
Description |
|
HRCR_ERROR |
Invalid
parameter or other error. |
|
HRCR_INVALIDGUIDE |
The guide
structure is invalid. |
|
HRCR_MEMERR |
Insufficient
memory. |
Comments
This function
is useful for doing boxed recognition. The GUIDE structure defines the size
and position of the boxes. The nFirstVisible parameter notifies the
recognizer which is the first visible character position (single-line controls)
or line (multiline controls) in case the contents were scrolled. The writing
direction affects the meaning of this value.
If lpguide
is NULL, or if all the members in the GUIDE structure are 0, the
recognizer does not use guides (free input).
See Also