ITfFnSearchCandidateProvider::GetSearchCandidates-Methode (ctffunc.h)

Ruft eine Liste der Konvertierungskandidaten für eine bestimmte Zeichenfolge ab, ohne IME-bezogene Nachrichten oder Ereignisse zu generieren.

Syntax

HRESULT GetSearchCandidates(
  [in]  BSTR             bstrQuery,
  [in]  BSTR             bstrApplicationId,
  [out] ITfCandidateList **pplist
);

Parameter

[in] bstrQuery

Eine Zeichenfolge, die die Lesezeichenfolge angibt, die der Textdienst zu konvertieren versucht.

[in] bstrApplicationId

App-angegebene Zeichenfolge, die es einem Textdienst ermöglicht, basierend auf dem Eingabeverlauf optional verschiedene Kandidaten für verschiedene Apps oder Kontexte bereitzustellen. Sie können einen leeren BSTR( L"" ) für einen generischen Kontext übergeben.

[out] pplist

Eine ITfCandidateList , die die angeforderten Kandidatendaten empfängt.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Rückgabecode	BESCHREIBUNG
S_OK	Die Methode war erfolgreich.
S_FALSE	Für die Eingabezeichenfolge konnten keine Kandidaten zurückgegeben werden, pplist kann NULL sein.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	ctffunc.h

Weitere Informationen

ITfFnSearchCandidateProvider

SearchPaneQueryLinguisticDetails

SetResult