Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfThreadMgr2::GetFunctionProvider method

Obtains the specified function provider object.

Syntax


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

Parameters

clsid [in]

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.

ValueMeaning
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.

 

ppFuncProv [out]

Pointer to a ITfFunctionProvider interface that receives the function provider.

Return value

This method can return one of these values.

ValueDescription
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

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

Msctf.h

IDL

Msctf.idl

See also

ITfThreadMgr2

 

 

Community Additions

Show:
© 2016 Microsoft