ITfInputProcessorProfiles::GetLanguageProfileDescription method (msctf.h)

Obtains the description string for a language profile.

Syntax

HRESULT GetLanguageProfileDescription(
  [in]  REFCLSID rclsid,
  [in]  LANGID   langid,
  [in]  REFGUID  guidProfile,
  [out] BSTR     *pbstrProfile
);

Parameters

[in] rclsid

Contains the CLSID of the text service to obtain the profile description for.

[in] langid

Contains a LANGID value that specifies which language to obtain the profile description for.

[in] guidProfile

Contains a GUID value that identifies the language to obtain the profile description for.

[out] pbstrProfile

Pointer to a BSTR value that receives the description string. The caller is responsible for freeing this memory using SysFreeString when it is no longer required.

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
pbstrProfile is invalid.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header msctf.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfInputProcessorProfiles

ITfInputProcessorProfiles::AddLanguageProfile

SysFreeString