ITextStoreAnchorSink::OnTextChange method

Syntax


HRESULT OnTextChange(
  [in] DWORD   dwFlags,
  [in] IAnchor *paStart,
  [in] IAnchor *paEnd
);

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

 

paStart [in]

Pointer to an anchor located at the start of the changed text.

paEnd [in]

Pointer to an anchor located at the end of the changed text.

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

E_FAIL

The method was unable to create cloned anchors to contain the change.

E_INVALIDARG

paStart or paEnd 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 ITextStoreAnchor method, such as ITextStoreAnchor::SetText.

 

Remarks

This method is called only when the application modifies its own text, not when a client modifies text with one of the ITextStoreAnchor methods, such as ITextStoreAnchor::SetText or ITextStoreAnchor::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

ITextStoreAnchorSink
ITextStoreAnchor
ITextStoreAnchor::SetText
ITextStoreAnchor::InsertTextAtSelection
Document Locks
Miscellaneous Text Store Constants

 

 

Show: