Windows Dev Center

ITfFunctionProvider::GetDescription method

Syntax


HRESULT GetDescription(
  [out] BSTR *pbstrDesc
);

Parameters

pbstrDesc [out]

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.

ValueDescription
S_OK

The method was successful.

E_OUTOFMEMORY

A memory allocation failure occurred.

E_INVALIDARG

pbstrDesc is invalid.

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

DLL

Msctf.dll

See also

ITfFunctionProvider
SysAllocString
SysFreeString

 

 

Community Additions

ADD
Show:
© 2015 Microsoft