Edit

Share via

ITfInputProcessorProfileActivationSink::OnActivated method (msctf.h)

  • Article

The ITfInputProcessorProfileActivationSink::OnActivated method is a callback that is called when an input processor profile is activated or deactivated.

Syntax

HRESULT OnActivated(
  [in] DWORD    dwProfileType,
  [in] LANGID   langid,
  [in] REFCLSID clsid,
  [in] REFGUID  catid,
  [in] REFGUID  guidProfile,
  [in] HKL      hkl,
  [in] DWORD    dwFlags
);

Parameters

[in] dwProfileType

[in] The type of this profile. This is one of these values.

Value Meaning
TF_PROFILETYPE_INPUTPROCESSOR
 This is a text service.
TF_PROFILETYPE_KEYBOARDLAYOUT
 This is a keyboard layout.

[in] langid

[in] Specifies the language id of the profile.

[in] clsid

[in] Specifies the CLSID of the text service. If dwProfileType is TF_PROFILETYPE_KEYBOARDLAYOUT, this is CLSID_NULL.

[in] catid

[in] Specifies the category of this text service. This category is GUID_TFCAT_TIP_KEYBOARD, GUID_TFCAT_TIP_SPEECH, GUID_TFCAT_TIP_HANDWRITING or something in GUID_TFCAT_CATEGORY_OF_TIP. If dwProfileType is TF_PROFILETYPE_KEYBOARDLAYOUT, this is GUID_NULL.

[in] guidProfile

[in] Specifies the GUID to identify the profile. If dwProfileType is TF_PROFILETYPE_KEYBOARDLAYOUT, this is GUID_NULL.

[in] hkl

[in] Specifies the keyboard layout handle of this profile. If dwProfileType is TF_PROFILETYPE_INPUTPROCESSOR, this is NULL.

[in] dwFlags

[in]

Value Meaning
TF_IPSINK_FLAG_ACTIVE
 This is on if this profile is activated.

Return value

The TSF manager ignores the return value of this method.

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