ImmGetDescriptionW, fonction (immdev.h)
Copie la description de l’IME dans la mémoire tampon spécifiée.
Syntaxe
UINT ImmGetDescriptionW(
HKL unnamedParam1,
[out, optional] LPWSTR 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 mémoire tampon nécessaire à 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, chacun composé de deux octets. Si le paramètre est défini sur 0, la fonction retourne la taille de la mémoire tampon requise en caractères Unicode, à l’exclusion du caractère null de fin Unicode.
Valeur retournée
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 des valeurs 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
Notes
L’en-tête immdev.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.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows XP [applications de bureau uniquement], prise en charge des langues d’Asie orientale installée., 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 | immdev.h (inclure Immdev.h, Windows.h) |
| Bibliothèque | Imm32.lib |
| DLL | Imm32.dll |