ITfThreadMgr::GetFunctionProvider method (msctf.h)

Article
02/22/2024

Obtains the specified function provider object.

Syntax

HRESULT GetFunctionProvider(
  [in]  REFCLSID            clsid,
  [out] ITfFunctionProvider **ppFuncProv
);

Parameters

[in] clsid

CLSID of the desired function provider. This can be the CLSID of a function provider registered for the calling thread or one of the following predefined values.

Value	Meaning
GUID_SYSTEM_FUNCTIONPROVIDER	Obtains the TSF system function provider.
GUID_APP_FUNCTIONPROVIDER	Obtains the function provider implemented by the current application. This object is not available if the application does not register itself as a function provider.

[out] ppFuncProv

Pointer to a ITfFunctionProvider interface that receives the function provider.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
TF_E_NOPROVIDER	No function provider matching clsid was available.
E_FAIL	GUID_SYSTEM_FUNCTIONPROVIDER was requested, but cannot be obtained.

Remarks

A function provider registers by calling the TSF manager ITfSourceSingle::AdviseSingleSink method with IID_ITfFunctionProvider.

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	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional