Edit

IPenInputPanel::CommitPendingInput method (peninputpanel.h)

  • Article

Deprecated. The PenInputPanel has been replaced by the Text Input Panel (TIP).

Sends collected ink to the recognizer and posts the recognition result.

Syntax

HRESULT CommitPendingInput();

Return value

This method can return one of these values.

Return code Description
S_OK
 Success.
E_UNEXPECTED
 Unexpected parameter or property type.
E_FAIL
 An unspecified error occurred.

Remarks

The writing pad sends the collected ink to the recognizer and clears the writing pad. The East Asian multibox sends recognized characters and clears multiboxes. The recognition result is sent to the control to which the PenInputPanel object is attached.

If there is no pending input or the CurrentPanel property is Keyboard, CommitPendingInput does nothing. If the PenInputPanel object is inactive, calling this method generates an error.

Starting with Microsoft Windows XP Tablet PC Edition 2005, ink is recognized as the user is entering. Therefore, the CommitPendingInput function sends the already recognized text to the edit control; it does not force recognition to occur.

Starting with Windows XP Tablet PC Edition 2005, if the PenInputPanel object is inactive, CommitPendingInput does not generate an error, it simply returns.

Requirements

Requirement Value
Minimum supported client Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header peninputpanel.h
Library InkObj.dll

See also

IPenInputPanel

PenInputPanel