Metodo ITfFnSearchCandidateProvider::GetSearchCandidates (ctffunc.h)

Ottiene un elenco di candidati di conversione per una determinata stringa senza generare messaggi o eventi correlati a IME.

Sintassi

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

Parametri

[in] bstrQuery

Stringa che specifica la stringa di lettura che il servizio di testo tenta di convertire.

[in] bstrApplicationId

Stringa specificata dall'app che consente a un servizio di testo di fornire facoltativamente candidati diversi a diverse app o contesti in base alla cronologia di input. È possibile passare un BSTR vuoto, L"", per un contesto generico.

[out] pplist

ITfCandidateList che riceve i dati candidati richiesti.

Valore restituito

Questo metodo può restituire uno di questi valori.

Codice restituito	Descrizione
S_OK	Il metodo è stato eseguito correttamente.
S_FALSE	Non è possibile restituire candidati per la stringa di input, pplist potrebbe essere NULL.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 8 [solo app desktop]
Server minimo supportato	Windows Server 2012 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	ctffunc.h

Vedi anche

ITfFnSearchCandidateProvider

SearchPaneQueryLinguisticDetails

SetResult