GetGuide function

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

Syntax


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

Parameters

hrc

The andle 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.

Return value

This function can return one of these values.

Return codeDescription
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.

 

Requirements

Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported

Header

Recapis.h

See also

SetGuide Function
RECO_GUIDE Structure

 

 

Show: