ImmGetGuideLineA, fonction (imm.h)

Article
11/20/2024

Récupère des informations sur les erreurs. Les applications utilisent les informations pour les notifications utilisateur.

Syntaxe

DWORD ImmGetGuideLineA(
  [in]            HIMC  unnamedParam1,
  [in]            DWORD dwIndex,
  [out, optional] LPSTR lpBuf,
  [in]            DWORD dwBufLen
);

Paramètres

[in] unnamedParam1

Gérer le contexte d’entrée.

[in] dwIndex

Type d’informations de recommandations à récupérer. Ce paramètre peut avoir l’une des valeurs suivantes.

Valeur	Signification
GGL_LEVEL	Retourne le niveau d’erreur.
GGL_INDEX	Retourne l’index d’erreur.
GGL_STRING	Retourne la chaîne de message d’erreur.
GGL_PRIVATE	Retourne des informations sur la conversion inverse.

[out, optional] lpBuf

Pointeur vers une mémoire tampon dans laquelle la fonction récupère la chaîne de message d’erreur. Ce paramètre contient NULL si dwIndex n’est pas GGL_STRING ou GGL_PRIVATE ou si dwBufLen a la valeur 0.

[in] dwBufLen

Taille, en octets, 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 recevoir la chaîne de message d’erreur, sans inclure le caractère null de fin.

Valeur de retour

Retourne un niveau d’erreur, un index d’erreur ou la taille d’une chaîne de message d’erreur, en fonction de la valeur du paramètre dwIndex. Si dwIndex est GGL_LEVEL, le retour est l’une des valeurs suivantes.

Valeur	Signification
GL_LEVEL_ERROR	Erreur. L’IME peut ne pas être en mesure de continuer.
GL_LEVEL_FATAL	Erreur irrécupérable. L’IME ne peut pas continuer et les données peuvent être perdues.
GL_LEVEL_INFORMATION	Aucune erreur. Les informations sont disponibles pour l’utilisateur.
GL_LEVEL_NOGUIDELINE	Aucune erreur. Supprimez le message d’erreur précédent s’il est toujours visible.
GL_LEVEL_WARNING	Entrée inattendue ou autre résultat. L’utilisateur doit être averti, mais l’IME peut continuer.

Si dwIndex est GGL_INDEX, la valeur de retour est l’une des valeurs suivantes.

Valeur	Signification
GL_ID_CANNOTSAVE	Le dictionnaire ou les données de statistiques ne peuvent pas être enregistrées.
GL_ID_NOCONVERT	L’IME ne peut plus être converti.
GL_ID_NODICTIONARY	L’IME ne trouve pas le dictionnaire, ou le dictionnaire a un format inattendu.
GL_ID_NOMODULE	L’IME ne trouve pas le module nécessaire.
GL_ID_READINGCONFLICT	Un conflit de lecture s’est produit. Par exemple, certaines voyelles ne peuvent pas être rassemblées pour former un caractère.
GL_ID_TOOMANYSTROKE	Il existe trop de traits pour un caractère ou une clause.
GL_ID_TYPINGERROR	Faute de frappe. L’IME ne peut pas gérer ce type.
GL_ID_UNKNOWN	Erreur inconnue. Reportez-vous à la chaîne de message d’erreur.
GL_ID_INPUTREADING	L’IME accepte l’entrée de caractère de lecture de l’utilisateur final.
GL_ID_INPUTRADICAL	L’IME accepte l’entrée de caractère radical de l’utilisateur final.
GL_ID_INPUTCODE	L’IME accepte l’entrée de code caractère de l’utilisateur final.
GL_ID_CHOOSECANDIDATE	L’IME accepte la sélection de chaînes candidates à partir de l’utilisateur final.
GL_ID_REVERSECONVERSION	Des informations sur la conversion inverse sont disponibles en appelant ImmGetGuideLine, en spécifiant GGL_PRIVATE. Les informations récupérées sont au format CANDIDATELIST.

Si dwIndex est GGL_STRING, la valeur de retour correspond au nombre d’octets de la chaîne copiée dans la mémoire tampon. Toutefois, si dwBufLen est 0, la valeur de retour est la taille de mémoire tampon nécessaire pour recevoir la chaîne, et non pas le caractère null de fin. Pour Unicode, si dwBufLen est 0, la valeur de retour est la taille, en octets, sans inclure le caractère Null de fin Unicode.

Si dwIndex est GGL_PRIVATE, la valeur de retour correspond au nombre d’octets d’informations copiées dans la mémoire tampon. Si dwIndex est GGL_PRIVATE et dwBufLen est 0, la valeur de retour est la taille de mémoire tampon nécessaire pour recevoir les informations.

Remarques

Les applications appellent généralement cette fonction après avoir reçu une commande IMN_GUIDELINE.

Note

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

IMN_GUIDELINE

du gestionnaire de méthodes d’entrée

fonctions Input Method Manager

Partager via