ITfCleanupContextDurationSink::OnStartCleanupContext method (msctf.h)

Called when a context cleanup operation is about to begin.

Syntax

HRESULT OnStartCleanupContext();

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

A context cleanup occurs when:

• The text service is deactivated while a context is still on the context stack. This can occur when the active text service is changed or when the active language changes while the text service is active.
• ITfThreadMgr::Deactivate is called while a context is still on the context stack.

ITfCleanupContextDurationSink::OnStartCleanupContext is called just before the TSF manager begins making ITfCleanupContextSink::OnCleanupContext notifications. When all of the OnCleanupContext notifications complete, the TSF manager calls OnEndCleanupContext.

Requirements

See also

ITfCleanupContextDurationSink interface, ITfCleanupContextDurationSink::OnEndCleanupContext, ITfCleanupContextSink::OnCleanupContext