Edit

ITfPropertyStore::OnTextUpdated method (msctf.h)

  • Article

Called when the text that the property store applies to is modified.

Syntax

HRESULT OnTextUpdated(
  [in]  DWORD    dwFlags,
  [in]  ITfRange *pRangeNew,
  [out] BOOL     *pfAccept
);

Parameters

[in] dwFlags

Contains a set of flags that provide additional information about the text change. This can be zero or the following value.

Value Meaning
TF_TU_CORRECTION
 The text change is the result of a correction. This implies that the semantics of the text have not changed. An example of this is when the spelling checker corrects a misspelled word.

[in] pRangeNew

Pointer to an ITfRange interface that contains the range of text modified.

[out] pfAccept

Pointer to a BOOL variable that receives a value that indicates if the property store should be retained. Receives a nonzero value if the property store should be retained or zero if the property store should be discarded. If the property store is discarded, the TSF manager will set the property value to VT_EMPTY and release the property store.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.

Remarks

If this method returns any value other than S_OK, the property store is discarded.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header msctf.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfPropertyStore

ITfRange