ImmGetCompositionStringA, fonction (imm.h)

Article
11/20/2024

Récupère des informations sur la chaîne de composition.

Syntaxe

LONG ImmGetCompositionStringA(
                  HIMC   unnamedParam1,
                  DWORD  unnamedParam2,
  [out, optional] LPVOID lpBuf,
  [in]            DWORD  dwBufLen
);

Paramètres

unnamedParam1

unnamedParam2

[out, optional] lpBuf

Pointeur vers une mémoire tampon dans laquelle la fonction récupère les informations de chaîne de composition.

[in] dwBufLen

Taille, en octets, de la mémoire tampon de sortie, même si la sortie est une chaîne Unicode. L’application définit ce paramètre sur 0 si la fonction doit retourner la taille de la mémoire tampon de sortie requise.

Valeur de retour

Retourne le nombre d’octets copiés dans la mémoire tampon de sortie. Si dwBufLen a la valeur 0, la fonction retourne la taille de la mémoire tampon, en octets, requise pour recevoir toutes les informations demandées, à l’exclusion du caractère null de fin. La valeur de retour est toujours la taille, en octets, même si les données demandées sont une chaîne Unicode.

Cette fonction retourne l’un des codes d’erreur négatifs suivants s’il ne réussit pas :

IMM_ERROR_NODATA. Les données de composition ne sont pas prêtes dans le contexte d’entrée.
IMM_ERROR_GENERAL. Erreur générale détectée par IME.

Remarques

Une application appelle cette fonction en réponse au message WM_IME_COMPOSITION ou WM_IME_STARTCOMPOSITION. Imm supprime les informations lorsque l’application appelle la fonction ImmReleaseContext.

Remarque Vous devez écrire du code pour gérer à la fois hiragana à largeur totale et katakana à demi-largeur si votre application est utilisée avec le panneau d’entrée réversible (SIP).

Note

L’en-tête imm.h définit ImmGetCompositionString 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 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

ImmReleaseContext

du gestionnaire de méthodes d’entrée

fonctions Input Method Manager

WM_IME_COMPOSITION

WM_IME_STARTCOMPOSITION

Partager via