ITextStoreACPSink::OnTextChange method

Syntax

C++
Copy 

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

Parameters

dwFlags [in]

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

ValueMeaning
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.

 

pChange [in]

Pointer to a TS_TEXTCHANGE structure that contains text change data.

Return value

This method can return one of these values.

ValueDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header
Textstor.h

IDL
Textstor.idl

DLL
Msctf.dll

See also

ITextStoreACPSink
TS_TEXTCHANGE
ITextStoreACP
ITextStoreACP::SetText
ITextStoreACP::InsertTextAtSelection
ITextStoreACP::RequestLock
Document Locks
Miscellaneous Text Store Constants

 

 

Show: