ITfInputProcessorProfileMgr::RegisterProfile method

The ITfInputProcessorProfileMgr::RegisterProfile method registers the text service and the profile.

Syntax

HRESULT RegisterProfile(
  REFCLSID    rclsid,
  LANGID      langid,
  REFGUID     guidProfile,
  const WCHAR *pchDesc,
  ULONG       cchDesc,
  const WCHAR *pchIconFile,
  ULONG       cchFile,
  ULONG       uIconIndex,
  HKL         hklsubstitute,
  DWORD       dwPreferredLayout,
  BOOL        bEnabledByDefault,
  DWORD       dwFlags
);

Parameters

rclsid

[in] CLSID of the text service.

langid

[in] The language id of the profile.

guidProfile

[in] The GUID to identify the profile.

pchDesc

[in, size_is(cchDesc)] The description of the profile.

cchDesc

[in] The length of pchDesc.

pchIconFile

[in, size_is(cchFile] The full path of the icon file.

cchFile

[in] The length of pchIconFile.

uIconIndex

[in] The icon index of the icon file for this profile.

hklsubstitute

[in] The substitute hkl of this profile.

dwPreferredLayout

[in] Unused. this must be 0.

bEnabledByDefault

[in] True if this profile is enabled by default.

dwFlags

[in] The combination of the following bits:

Value Meaning
TF_RP_HIDDENINSETTINGUI
This profile will not appear in the setting UI.
TF_RP_LOCALPROCESS
This profile is available only on the local process.
TF_RP_LOCALTHREAD
This profile is available only on the local thread.

Return Value

This method can return one of these values.

Value Description
S_OK
The method was successful.
E_FAIL
An unspecified error occurred.
E_INVALIDARG
One or more parameters are invalid.

Requirements

   
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