Fonction DrawTextWrap

Article
06/13/2023

[DrawTextWrap est disponible via Windows XP avec Service Pack 2 (SP2). Il peut être modifié ou indisponible dans les versions suivantes. Il est recommandé d’utiliser DrawText directement à la place.]

Dessine le texte mis en forme dans le rectangle spécifié. Il met en forme le texte en fonction de la méthode spécifiée (développement des onglets, caractères de justification, lignes cassantes, etc.). Cette fonction encapsule un appel à DrawText.

Syntaxe

int WINAPI DrawTextWrap(
  _In_    HDC              hdc,
  _Inout_ LPCTSTR          lpString,
  _In_    int              nCount,
  _Inout_ LPRECT           lpRect,
  _In_    UINT             uFormat,
  _In_    LPDRAWTEXTPARAMS lpDTParams
);

Paramètres

hdc [in]

Type : HDC

Handle dans le contexte de l’appareil.

lpString [in, out]

Type : LPCTSTR

Pointeur vers une mémoire tampon qui contient le texte à dessiner. Si le paramètre nCount est -1, la chaîne doit être terminée par null.

Si uFormat inclut DT_MODIFYSTRING, la fonction peut ajouter jusqu’à quatre caractères supplémentaires à cette chaîne. La mémoire tampon qui contient la chaîne doit être suffisamment grande pour accueillir ces caractères supplémentaires.

nCount [in]

Type : int

Longueur de la chaîne pointée vers lpString. Si nCount a la valeur -1, le paramètre lpString est supposé être un pointeur vers une chaîne terminée par null et DrawText calcule automatiquement le nombre de caractères.

lpRect [in, out]

Type : LPRECT

Pointeur vers une structure RECT qui contient le rectangle, en coordonnées logiques, dans lequel le texte doit être mis en forme.

uFormat [in]

Type : UINT

Options de mise en forme. Consultez la documentation de DrawText pour obtenir la liste complète des options.

lpDTParams [in]

Type : LPDRAWTEXTPARAMS

Pointeur vers une structure DRAWTEXTPARAMS qui spécifie des options de mise en forme supplémentaires. Ce paramètre peut être NULL.

Valeur retournée

Type : int

Si la fonction réussit, la valeur de retour est la hauteur de texte en unités logiques. Si DT_VCENTER ou DT_BOTTOM est spécifié, la valeur de retour est le décalage entre le membre supérieur de lprc et le bas du texte dessiné Si la fonction échoue, la valeur de retour est zéro.

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

Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

DrawTextWrap n’est pas exporté par nom ni déclaré dans un en-tête public. Pour l’utiliser, vous devez utiliser GetProcAddress et demander l’ordinal 415 à ComCtl32.dll pour obtenir un pointeur de fonction.

Pour des remarques supplémentaires, consultez DrawText.

Spécifications

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
DLL	Comctl32.dll (version 6.0 ou ultérieure)