ITfFnGetLinguisticAlternates::GetAlternates method (ctffunc.h)

Returns a list of alternate strings for a given text range.

Syntax

HRESULT GetAlternates(
  [in]  ITfRange         *pRange,
  [out] ITfCandidateList **ppCandidateList
);

[in] pRange

Pointer to an ITfRange object that covers the text to return alternates for.

[out] ppCandidateList

Pointer to an ITfCandidateList pointer that receives the list object containing alternate strings.

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_FAIL	An unspecified error occurred or no alternates could be generated for the range. *ppCandidateList is returned as null.
E_OUTOFMEMORY	A memory allocation failure occurred.
E_INVALIDARG	One or more parameters are invalid.

Requirement	Value
Minimum supported client	Windows 8.1 [desktop apps only]
Minimum supported server	Windows Server 2012 R2 [desktop apps only]
Target Platform	Windows
Header	ctffunc.h