ITfCleanupContextDurationSink::OnStartCleanupContext method

Syntax


HRESULT OnStartCleanupContext();

Parameters

This method has no parameters.

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.

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

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

DLL

Imekrcic.dll

See also

ITfCleanupContextDurationSink
ITfCleanupContextSink::OnCleanupContext
ITfCleanupContextDurationSink::OnEndCleanupContext

 

 

Show: