Edit

Share via

ITfInputScope::GetPhrase method (inputscope.h)

  • Article

Gets the phrase list set to this context.

Syntax

HRESULT GetPhrase(
  [out] BSTR **ppbstrPhrases,
  [out] UINT *pcCount
);

Parameters

[out] ppbstrPhrases

Pointer to an array of pointers to strings containing phrases. The calling function must call SystFreeString() to free the memory allocated to the strings and CoTaskMemFree to free the buffer.

[out] pcCount

Pointer to the number of phrases returned.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps | UWP apps]
Minimum supported server Windows Server 2003 [desktop apps | UWP apps]
Target Platform Windows
Header inputscope.h
DLL Msctf.dll