ImmGetCandidateListA, fonction (imm.h)

Récupère une liste de candidats.

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 des candidats.

[in] dwBufLen

Taille, en octets, de la mémoire tampon pour recevoir la liste des candidats. 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 retournée

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

Notes

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. La combinaison 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.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement], prise en charge des langues d’Asie de l’Est installée.
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	imm.h (inclure Immdev.h, Windows.h)
Bibliothèque	Imm32.lib
DLL	Imm32.dll

Voir aussi

CANDIDATELIST

Gestionnaire de méthodes d’entrée

Fonctions du gestionnaire de méthodes d’entrée