Edit

Share via

ITfHandwriting::RequestHandwritingForPointer method (shellhandwriting.h)

  • Article

Requests that the specified pointer and ink stroke be used for the handwriting experience.

Syntax

HRESULT RequestHandwritingForPointer(
  [in]  UINT32                pointerId,
  [in]  UINT64                handwritingStrokeId,
  [out] BOOL                  *requestAccepted,
  [out] ITfHandwritingRequest **request
);

Parameters

[in] pointerId

The pointer identifier.

[in] handwritingStrokeId

The ink stroke identifier.

You must call GetHandwritingStrokeIdForPointer to retrieve the unique ID of the stroke started by a WM_POINTERDOWN message.

[out] requestAccepted

True, if the request was accepted; otherwise, false.

[out] request

A pointer to an ITfHandwritingRequest object.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

This method can only be called when the current handwriting state for the pointerId is set to TF_HANDWRITING_POINTERDELIVERY or TF_USE_POINTER_DELIVERY is the response to a handwriting proximity callback, otherwise it will return E_INVALIDARG.

This method must be called within two seconds of receiving a WM_POINTERDOWN message for pointerId. If this method is not called within this two second time frame, S_OK is returned, but requestAccepted will be set to false.

Requirements

Requirement Value
Header shellhandwriting.h

See also

SetHandwritingState