GetGuide Function

GetGuide Function

Returns the guide used for boxed or lined input.

Syntax

[C++]

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

Parameters

hrc

[in] Handle to the recognizer context.

pGuide

[out] Guide used for box or line input. For guide details, see the RECO_GUIDE structure.

piIndex

[out] Index value of the first box or line in the context.

Return Value

HRESULT value Description
S_OK Success.
S_FALSE The context does not contain a guide.
E_POINTER One of the parameters is an invalid pointer.