Fonction SetConsoleDisplayMode
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.
Définit le mode d’affichage de la mémoire tampon d’écran de la console spécifiée.
Syntaxe
BOOL WINAPI SetConsoleDisplayMode(
_In_ HANDLE hConsoleOutput,
_In_ DWORD dwFlags,
_Out_opt_ PCOORD lpNewScreenBufferDimensions
);
Paramètres
hConsoleOutput [entrée]
Handle vers la mémoire tampon d’écran de console.
dwFlags [in]
Mode d’affichage de la console. Ce paramètre peut prendre l’une ou plusieurs des valeurs suivantes.
| Valeur | Signification |
|---|---|
| CONSOLE_FULLSCREEN_MODE 1 | Le texte s’affiche en mode plein écran. |
| CONSOLE_WINDOWED_MODE 2 | Le texte s’affiche dans une fenêtre de console. |
lpNewScreenBufferDimensions [sortie, facultatif]
Un pointeur vers une structure COORD qui reçoit les nouvelles dimensions de la mémoire tampon d’écran, en caractères.
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 XP [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2003 [applications de bureau uniquement] |
| En-tête | ConsoleApi3.h (via WinCon.h, inclure Windows.h) |
| Bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |