Edit

Share via

ITfInputProcessorProfileMgr::GetActiveProfile method (msctf.h)

  • Article

This method returns the current active profile.

Syntax

HRESULT GetActiveProfile(
  [in]  REFGUID                  catid,
  [out] TF_INPUTPROCESSORPROFILE *pProfile
);

Parameters

[in] catid

[in] The category id for the profile. This must be GUID_TFCAT_TIP_KEYBOARD. Only GUID_TFCAT_TIP_KEYBOARD is supported.

[out] pProfile

[out] The buffer to receive the profile information.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
S_FALSE
 The profile was not found or is not active.
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