Fonction TabbedTextOutA (winuser.h)

Article
03/04/2024

La fonction TabbedTextOut écrit une chaîne de caractères à un emplacement spécifié, développant les onglets aux valeurs spécifiées dans un tableau de positions de taquet de tabulation. Le texte est écrit dans la police, la couleur d’arrière-plan et la couleur du texte actuellement sélectionnées.

Syntaxe

LONG TabbedTextOutA(
  [in] HDC       hdc,
  [in] int       x,
  [in] int       y,
  [in] LPCSTR    lpString,
  [in] int       chCount,
  [in] int       nTabPositions,
  [in] const INT *lpnTabStopPositions,
  [in] int       nTabOrigin
);

Paramètres

[in] hdc

Handle dans le contexte de l’appareil.

[in] x

Coordonnée x du point de départ de la chaîne, en unités logiques.

[in] y

Coordonnée y du point de départ de la chaîne, en unités logiques.

[in] lpString

Pointeur vers la chaîne de caractères à dessiner. La chaîne n’a pas besoin d’être terminée à zéro, car nCount spécifie la longueur de la chaîne.

[in] chCount

Longueur de la chaîne pointée vers lpString.

[in] nTabPositions

Nombre de valeurs dans le tableau de positions de taquet de tabulation.

[in] lpnTabStopPositions

Pointeur vers un tableau contenant les positions de tabulation, en unités logiques. Les taquets de tabulation doivent être triés dans un ordre croissant ; la plus petite x-value doit être le premier élément du tableau.

[in] nTabOrigin

Coordonnée x de la position de départ à partir de laquelle les onglets sont développés, en unités logiques.

Valeur retournée

Si la fonction réussit, la valeur de retour correspond aux dimensions, en unités logiques, de la chaîne. La hauteur est dans le mot d’ordre élevé et la largeur est dans le mot d’ordre inférieur.

Si la fonction échoue, la valeur de retour est égale à zéro.

Remarques

Si le paramètre nTabPositions est égal à zéro et que le paramètre lpnTabStopPositions a la valeur NULL, les onglets sont étendus à huit fois la largeur moyenne des caractères.

Si nTabPositions a la valeur 1, les tabulations sont séparées par la distance spécifiée par la première valeur du tableau lpnTabStopPositions .

Si le tableau lpnTabStopPositions contient plusieurs valeurs, un taquet de tabulation est défini pour chaque valeur du tableau, jusqu’au nombre spécifié par nTabPositions.

Le paramètre nTabOrigin permet à une application d’appeler la fonction TabbedTextOut plusieurs fois pour une seule ligne. Si l’application appelle TabbedTextOut plusieurs fois avec nTabOrigin défini sur la même valeur à chaque fois, la fonction développe tous les onglets par rapport à la position spécifiée par nTabOrigin.

Par défaut, la position actuelle n’est pas utilisée ou mise à jour par la fonction TabbedTextOut . Si une application doit mettre à jour la position actuelle lorsqu’elle appelle TabbedTextOut, l’application peut appeler la fonction SetTextAlign avec le paramètre wFlags défini sur TA_UPDATECP. Lorsque cet indicateur est défini, le système ignore les paramètres X et Y lors des appels suivants à la fonction TabbedTextOut , en utilisant plutôt la position actuelle.

Note Pour Windows Vista et versions ultérieures, TabbedTextOut ignore l’alignement du texte lorsqu’il dessine du texte.

Notes

L’en-tête winuser.h définit TabbedTextOut comme un 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 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winuser.h (inclure Windows.h)
Bibliothèque	User32.lib
DLL	User32.dll
Ensemble d’API	ext-ms-win-ntuser-misc-l1-5-1 (introduit dans Windows 10, version 10.0.14393)