ITfTextInputProcessor::Deactivate method (msctf.h)

Deactivates a text service when a user session ends.

Syntax

HRESULT Deactivate();

Return value

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

Remarks

TSF calls this method immediately before releasing its final reference to a text service. This provides the opportunity to perform operations necessary to shut down the text service.

This method usually unadvises sinks for events that involve the text service. It can also close any user interface elements of the text service.

Before this method returns, it must release all references to the ptim parameter passed to the text service by the ITfTextInputProcessor::Activate method.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header msctf.h
DLL Tiptsf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfTextInputProcessor

ITfTextInputProcessor::Activate