Edit

Share via

ITextStoreACPSink::OnTextChange method (textstor.h)

Called when the text of a document changes.

Syntax

HRESULT OnTextChange(
  [in] DWORD               dwFlags,
  [in] const TS_TEXTCHANGE *pChange
);

Parameters

[in] dwFlags

Contains a set of flags that specify additional information about the text change. This can be one or more of the following values.

Value Meaning
0
 The text has changed.
TS_ST_CORRECTION
 The text is a transform (correction) of existing content, and any special text markup information (metadata) is retained, such as .wav file data or a language identifier. This flag is used for applications that need to preserve data associated with the original text.

[in] pChange

Pointer to a TS_TEXTCHANGE structure that contains text change data.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
E_INVALIDARG
 pChange is invalid.
E_OUTOFMEMORY
 A memory allocation failure occurred.
TS_E_NOLOCK
 The TSF manager holds a lock on the document. This typically indicates that the method was called from within another ITextStoreACP method, such as ITextStoreACP::SetText.

Remarks

ITextStoreACPSink::OnTextChange is never called when the text is modified by one of the ITextStoreACP interface methods, such as ITextStoreACP::SetText or ITextStoreACP::InsertTextAtSelection.

When calling this method, the application must be able to grant a document lock.

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 textstor.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

Document Locks

ITextStoreACP

ITextStoreACP::InsertTextAtSelection

ITextStoreACP::RequestLock

ITextStoreACP::SetText

ITextStoreACPSink

Miscellaneous Text Store Constants

TS_TEXTCHANGE