ImmGetCandidateListA, fonction (imm.h)

Récupère une liste candidate.

Syntaxe

DWORD ImmGetCandidateListA(
                  HIMC            unnamedParam1,
  [in]            DWORD           deIndex,
  [out, optional] LPCANDIDATELIST lpCandList,
  [in]            DWORD           dwBufLen
);

Paramètres

unnamedParam1

[in] deIndex

Index de base zéro de la liste candidate.

[out, optional] lpCandList

Pointeur vers une structure CANDIDATELIST dans laquelle la fonction récupère la liste candidate.

[in] dwBufLen

Taille, en octets, de la mémoire tampon pour recevoir la liste candidate. L’application peut spécifier 0 pour ce paramètre si la fonction doit retourner la taille requise de la mémoire tampon de sortie uniquement.

Valeur de retour

Retourne le nombre d’octets copiés dans la mémoire tampon de liste candidate en cas de réussite. Si l’application a fourni 0 pour le paramètre dwBufLen, la fonction retourne la taille requise pour la mémoire tampon de liste candidate.

La fonction retourne 0 si elle ne réussit pas.

Remarques

Note

L’en-tête imm.h définit ImmGetCandidateList comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence Valeur
client minimum pris en charge Windows XP [applications de bureau uniquement], prise en charge linguistique de l’Asie de l’Est installée.
serveur minimum pris en charge Windows Server 2003 [applications de bureau uniquement]
plateforme cible Windows
d’en-tête imm.h (include Immdev.h, Windows.h)
bibliothèque Imm32.lib
DLL Imm32.dll

Voir aussi

CANDIDATELIST

du gestionnaire de méthodes d’entrée

fonctions Input Method Manager