GetGuide function (recapis.h)

Retrieves the guide used for boxed, lined, or freeform input.

Syntax

HRESULT GetGuide(
  HRECOCONTEXT hrc,
  RECO_GUIDE   *pGuide,
  ULONG        *piIndex
);

hrc

The handle to the recognizer context.

pGuide

A guide used for boxed, lined, or freeform input. For guide details, see the RECO_GUIDE structure.

piIndex

Index value of the first box or line in the context.

This function can return one of these values.

Return code	Description
S_OK	Success.
S_FALSE	The context does not contain a guide.
E_FAIL	An unspecified error occurred.
E_INVALIDARG	An invalid argument was received.
E_POINTER	One of the parameters is an invalid pointer.


Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	recapis.h