Méthode ITfFnSearchCandidateProvider ::GetSearchCandidates (ctffunc.h)

Article
03/01/2024

Obtient une liste de candidats à la conversion pour une chaîne donnée sans générer de messages ou d’événements liés à l’IME.

Syntaxe

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

Paramètres

[in] bstrQuery

Chaîne qui spécifie la chaîne de lecture que le service de texte tente de convertir.

[in] bstrApplicationId

Chaîne spécifiée par l’application qui permet à un service de texte de fournir éventuellement différents candidats à différents contextes ou applications en fonction de l’historique des entrées. Vous pouvez passer un BSTR vide, L" », pour un contexte générique.

[out] pplist

ITfCandidateList qui reçoit les données candidates demandées.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	La méthode a réussi.
S_FALSE	Aucun candidat n’a pu être retourné pour la chaîne d’entrée, pplist peut avoir la valeur NULL.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2012 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	ctffunc.h

Voir aussi

ITfFnSearchCandidateProvider

SearchPaneQueryLinguisticDetails

SetResult

Partager via