Fonction GetConsoleScreenBufferInfo

Article
12/22/2023

Récupère des informations sur la mémoire tampon d’écran de la console spécifiée.

Syntaxe

BOOL WINAPI GetConsoleScreenBufferInfo(
  _In_  HANDLE                      hConsoleOutput,
  _Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

Paramètres

hConsoleOutput [entrée]
Un descripteur vers la mémoire tampon de l’écran de la console. Le descripteur doit avoir le droit d’accès GENERIC_READ. Pour plus d’informations, consultez Sécurité de la mémoire tampon et droits d’accès d’une console.

lpConsoleScreenBufferInfo [sortie]
Un pointeur vers une structure CONSOLE_SCREEN_BUFFER_INFO qui reçoit les informations sur la mémoire tampon de l'écran de la console.

Valeur renvoyée

Si la fonction réussit, la valeur de retour est différente de 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.

Notes

Le rectangle renvoyé dans le membre srWindow de la structure CONSOLE_SCREEN_BUFFER_INFO peut être modifié, puis transmis à la fonction SetConsoleWindowInfo pour faire défiler la mémoire tampon de l'écran de la console dans la fenêtre, pour modifier la taille de la fenêtre, ou les deux.

Toutes les coordonnées renvoyées dans la structure CONSOLE_SCREEN_BUFFER_INFO sont des coordonnées de cellules de caractères, où l'origine (0, 0) se trouve dans le coin supérieur gauche de la mémoire tampon de l'écran de la console.

Conseil

Cette API n'a pas d'équivalent au niveau des terminaux virtuels. Son utilisation peut toujours être nécessaire pour les applications qui tentent de dessiner des colonnes, des grilles ou de remplir l’affichage pour récupérer la taille de la fenêtre. Cet état de fenêtre est géré par le ATS/PTY/Pseudoconsole en dehors du flux normal et est généralement considéré comme un privilège utilisateur non ajustable par l'application cliente. Les mises à jour peuvent être reçues sur ReadConsoleInput.

Exemples

Pour obtenir un exemple, consultez Défilement de la fenêtre d’une mémoire tampon d’écran.

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
En-tête	ConsoleApi2.h (via WinCon.h, include Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll