Edit

Share via

ITfInputProcessorProfileMgr::ActivateProfile method (msctf.h)

  • Article

The ITfInputProcessorProfileMgr::ActivateProfile method activates the specified text service's profile or keyboard layout.

Syntax

HRESULT ActivateProfile(
  [in] DWORD    dwProfileType,
  [in] LANGID   langid,
  [in] REFCLSID clsid,
  [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] The language id of the profile to be activated.

[in] clsid

[in] The CLSID of the text service of the profile to be activated. This must be CLSID_NULL if dwProfileType is TF_PROFILETYPE_KEYBOARDLAYOUT.

[in] guidProfile

[in] The guidProfile of the profile to be activated. This must be GUID_NULL if dwProfileType is TF_PROFILETYPE_KEYBOARDLAYOUT.

[in] hkl

[in] The handle of the keyboard layout. This must be NULL if dwProfileType is TF_PROFILETYPE_INPUTPROCESSOR.

[in] dwFlags

The combination of the following bits:

Value Meaning
TF_IPPMF_FORPROCESS
 Activate this profile for all threads in the process.
TF_IPPMF_FORSESSION
 Activate this profile for all threads in the current desktop.
TF_IPPMF_ENABLEPROFILE
 Update the registry to enable this profile for this user.
TF_IPPMF_DISABLEPROFILE
TF_IPPMF_DONTCARECURRENTINPUTLANGUAGE
 If the current input language does not match with the requested profile's language, TSF marks this profile to be activated when the requested input language is switched. If this flag is off and the current input language is not matched, this method fails.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
S_FALSE
 The language profile is not enabled.
E_FAIL
 An unspecified error occurred.
E_INVALIDARG
 One or more parameters are invalid.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2003 R2 [desktop apps | UWP apps]
Target Platform Windows
Header msctf.h
DLL Msctf.dll

See also

ITfInputProcessorProfileMgr

ITfInputProcessorProfileMgr::DeactivateProfile