Edit

ITfFunctionProvider::GetDescription method (msctf.h)

  • Article

Obtains the description of the function provider.

Syntax

HRESULT GetDescription(
  [out] BSTR *pbstrDesc
);

Parameters

[out] pbstrDesc

Pointer to a BSTR that receives the description string. This value must be allocated using SysAllocString. The caller must 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_OUTOFMEMORY
 A memory allocation failure occurred.
E_INVALIDARG
 pbstrDesc is invalid.

Requirements

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

See also

ITfFunctionProvider

SysAllocString

SysFreeString