ITfInputProcessorProfileMgr::GetProfile method

The ITfInputProcessorProfileMgr::GetProfile method returns the information of the specified text service's profile or keyboard layout in TF_INPUTPROCESSORPROFILE structure.

Syntax


HRESULT GetProfile(
  [in]  DWORD                    dwProfileType,
  [in]  LANGID                   langid,
  [in]  REFCLSID                 clsid,
  [in]  REFGUID                  guidProfile,
  [in]  HKL                      hkl,
  [out] TF_INPUTPROCESSORPROFILE *pProfile
);

Parameters

dwProfileType [in]

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

ValueMeaning
TF_PROFILETYPE_INPUTPROCESSOR

This is a text service.

TF_PROFILETYPE_KEYBOARDLAYOUT

This is a keyboard layout.

 

langid [in]

[in] The language id of the profile to be activated.

clsid [in]

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

guidProfile [in]

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

hkl [in]

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

pProfile [out]

[out] The buffer to receive TF_INPUTPROCESSORPROFILE.

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

 

 

Show: