ITipAutocompleteProvider::UpdatePendingText method

  • Article

Used by the auto complete client to notify the application of the text a user has inked into Input Panel.

Syntax

HRESULT UpdatePendingText(
  [in] BSTR bstrPendingText
);

Parameters

bstrPendingText [in]

Source text to be used to generate the auto complete list.

Return value

This method can return one of these values.

Return code Description
S_OK
 Success.
E_FAIL
 An unspecified error occurred.

Remarks

This text will not contain the text already inserted in the focused field. The auto complete provider is responsible for taking into account the current field text and the selection to generate the auto complete list. When bstrPendingText is NULL, the auto complete list is generated with the current text to the left of the selection in the field.

Requirements

Requirement Value
Minimum supported client
 Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server
 None supported
Header
TipAutoComplete.h (also requires Peninputpanel_i.c)
DLL
Tiptsf.dll

See also

ITipAutocompleteProvider Interface

Text Input Panel Reference