Partager via


Fonction SetConsoleActiveScreenBuffer

Important

Ce document décrit les fonctionnalités de la plateforme de la console qui ne font plus partie de la feuille de route de notre é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 terminaux virtuels pour une compatibilité maximale dans les scénarios multiplateformes. Vous trouverez plus d’informations sur cette décision de conception dans notre document sur les consoles classiques et les terminaux virtuels.

Définit la mémoire tampon d’écran spécifiée comme mémoire tampon de l’écran de la console actuellement affichée.

Syntaxe

BOOL WINAPI SetConsoleActiveScreenBuffer(
  _In_ HANDLE hConsoleOutput
);

Paramètres

hConsoleOutput [entrée]
Un descripteur vers 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

Une console peut avoir plusieurs mémoires tampons d’écran. La fonction SetConsoleActiveScreenBuffer détermine celle qui est affichée. Vous pouvez écrire dans une mémoire tampon d’écran inactive, puis utiliser la fonction SetConsoleActiveScreenBuffer pour afficher le contenu de la mémoire tampon.

Conseil

Cette API n’est pas recommandée, mais elle a un équivalent approximatif de terminal virtuel dans la séquence de mémoires tampons d’écran alternatif. La définition de la mémoire tampon de l'écran alternative peut fournir à une application un espace séparé et isolé pour dessiner au cours du runtime de la session, tout en préservant le contenu affiché par l'invocateur de l'application. Les informations relatives au dessin sont ainsi conservées pour permettre une restauration simple lors de la sortie du processus.

Exemples

Pour obtenir un exemple, consultez la section Lecture et écriture de blocs de caractères et d’attributs.

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

Voir aussi

Fonctions de console

Mémoires tampons d’écran d’une console

CreateConsoleScreenBuffer