Windows Dev Center

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.

ITfInputProcessorProfileMgr::RegisterProfile method

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

Syntax


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

Parameters

rclsid [in]

[in] CLSID of the text service.

langid [in]

[in] The language id of the profile.

guidProfile [in]

[in] The GUID to identify the profile.

pchDesc

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

cchDesc [in]

[in] The length of pchDesc.

pchIconFile

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

cchFile [in]

[in] The length of pchIconFile.

uIconIndex [in]

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

hklSubstitute [in]

[in] The substitute hkl of this profile.

dwPreferredLayout [in]

[in] Unused. this must be 0.

bEnabledByDefault [in]

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

dwFlags [in]

[in] The combination of the following bits:

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

ValueDescription
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 | Windows Store apps]

Minimum supported server

Windows Server 2003 R2 [desktop apps | Windows Store apps]

Header

Msctf.h

IDL

Msctf.idl

DLL

Msctf.dll

 

 

Community Additions

Show:
© 2015 Microsoft