Edit

Share via

ITfSourceSingle::UnadviseSingleSink method (msctf.h)

  • Article

Uninstalls an advise sink.

Syntax

HRESULT UnadviseSingleSink(
  [in] TfClientId tid,
  [in] REFIID     riid
);

Parameters

[in] tid

Contains a TfClientId value that identifies the client.

[in] riid

Identifies the type of advise sink to uninstall. This can be one of the following values.

Value Meaning
IID_ITfCleanupContextDurationSink
 Uninstalls the ITfCleanupContextDurationSink advise sink. Applies to: Text service
IID_ITfCleanupContextSink
 Uninstalls the ITfCleanupContextSink advise sink. Applies to: Text service
IID_ITfFunctionProvider
 Unregisters the client as a function provider. Applies to: Text Service and Application

Return value

This method can return one of these values.

Value Description
S_OK
 The advise sink was successfully uninstalled.
E_INVALIDARG
 tid is invalid.
CONNECT_E_NOCONNECTION
 The advise sink is not installed.

Requirements

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