Vcl.Controls.TControl.GetTextBuf

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function GetTextBuf(Buffer: PChar; BufSize: Integer): Integer;

C++

int __fastcall GetTextBuf(System::WideChar * Buffer, int BufSize);

Propriétés

Type Visibilité  Source Unité  Parent
function public
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls TControl

Description

Récupère le texte du contrôle, le copie dans un tampon et renvoie le nombre de caractères copiés.

Appelez GetTextBuf pour récupérer le texte d'un contrôle dans un tampon de taille fixe. Le texte copié correspond à la valeur de la propriété Text. GetTextBuf renvoie le nombre de caractères effectivement copiés, c'est-à-dire la plus faible des deux valeurs suivantes : longueur de la propriété Text et BufSize - 1.

Pour déterminer le nombre de caractères nécessaires au tampon pour contenir la totalité du texte, appelez la méthode GetTextLen avant d'allouer un tampon pour GetTextBuf.

Remarque :  GetTextBuf est proposée dans un souci de compatibilité avec le code 16 bits. Si la compatibilité n'est pas nécessaire, utilisez la propriété Text.

Remarque :  Pour obtenir le texte du contrôle sous forme d'AnsiString, utilisez plutôt la propriété Text.

Voir aussi