Partager via


Fonction SetConsoleScreenBufferSize

Important

Ce document décrit les fonctionnalités de la plateforme de console qui ne font plus partie de notre feuille de route de l’écosystème. Nous vous déconseillons d’utiliser ce contenu dans de nouveaux produits, mais nous continuerons prendre en charge des utilisations existantes pour l’avenir indéterminé. Notre solution moderne préférée se concentre sur les séquences de terminal virtuel pour une compatibilité maximale dans les scénarios multiplateformes. Vous trouverez plus d’informations sur cette décision de conception dans notre document console classique versus terminal virtuel.

Change la taille de la mémoire tampon de l’écran de console spécifié.

Syntaxe

BOOL WINAPI SetConsoleScreenBufferSize(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwSize
);

Paramètres

hConsoleOutput [entrée]
Handle vers la mémoire tampon d’écran de console. Le handle 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.

dwSize [entrée]
Une structure COORD qui spécifie la nouvelle taille de la mémoire tampon d’écran de la console, en lignes de caractères et colonnes. La largeur et la hauteur spécifiées ne peuvent pas être inférieures à la largeur et à la hauteur de la fenêtre de la mémoire tampon de l’écran de console. Les dimensions spécifiées ne peuvent pas non plus être inférieures à la taille minimale autorisée par le système. Ce minimum dépend de la taille de police actuelle pour la console (sélectionnée par l’utilisateur) et des valeurs SM_CXMIN et SM_CYMIN retournées par la fonction GetSystemMetrics.

Valeur retourné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

Conseil

Cette API n’est pas recommandée et n’a pas d’équivalent au terminal virtuel. Cette décision aligne intentionnellement la plateforme Windows avec d’autres systèmes d’exploitation où l’utilisateur dispose d’un contrôle total sur cette option de présentation. Le remoting des applications via des utilitaires multiplateformes et des transports comme SSH peut ne pas fonctionner comme prévu si vous utilisez cette API.

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, inclure Windows.h)
Bibliothèque Kernel32.lib
DLL Kernel32.dll

Voir aussi

Fonctions de console

Mémoire tampon d’entrée d’une console

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo