Partager via


ImmGetDescriptionA, fonction (imm.h)

Copie la description de l’IME dans la mémoire tampon spécifiée.

Syntaxe

UINT ImmGetDescriptionA(
                  HKL   unnamedParam1,
  [out, optional] LPSTR lpszDescription,
  [in]            UINT  uBufLen
);

Paramètres

unnamedParam1

[out, optional] lpszDescription

Pointeur vers une mémoire tampon dans laquelle la fonction récupère la chaîne terminée par null décrivant l’IME.

[in] uBufLen

Taille, en caractères, de la mémoire tampon de sortie. L’application définit ce paramètre sur 0 si la fonction doit retourner la taille de la mémoire tampon nécessaire pour la description complète, à l’exclusion du caractère null de fin.

Windows NT, Windows 2000, Windows XP : La taille de la mémoire tampon est en caractères Unicode, chacune composée de deux octets. Si le paramètre est défini sur 0, la fonction retourne la taille de la mémoire tampon requise dans les caractères Unicode, à l’exclusion du caractère Null de fin Unicode.

Valeur de retour

Retourne le nombre de caractères copiés dans la mémoire tampon de sortie. Si l’application définit le paramètre uBufLen sur 0, la fonction retourne la taille de la mémoire tampon requise pour recevoir la description. Aucune valeur n’inclut le caractère null de fin. Pour Unicode, la fonction retourne le nombre de caractères Unicode, sans inclure le caractère Null de fin Unicode.

Remarques

Note

L’en-tête imm.h définit ImmGetDescription en tant qu’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 orientale installée., 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

du gestionnaire de méthodes d’entrée

fonctions Input Method Manager