SetConsoleTextAttribute-Funktion

Artikel
12/15/2023

Wichtig

In diesem Dokument werden Konsolenplattformfunktionen beschrieben, die nicht mehr Teil unserer Ökosystem-Roadmap sind. Wir empfehlen nicht, diesen Inhalt in neuen Produkten zu verwenden, aber wir werden weiterhin vorhandene Nutzungen für die unbegrenzte Zukunft unterstützen. Unsere bevorzugte moderne Lösung konzentriert sich auf virtuelle Terminalsequenzen für maximale Kompatibilität in plattformübergreifenden Szenarien. Weitere Informationen zu dieser Designentscheidung finden Sie in unserem Dokument klassische Konsole im Vergleich zum virtuellen Terminal.

Legt die Attribute von Zeichen fest, die von der WriteFile- oder WriteConsole-Funktion in den Konsolenbildschirmpuffer geschrieben wurden oder von der Funktion ReadFile oder ReadConsole ausgegeben wurden. Diese Funktion wirkt sich auf Text aus, der nach dem Funktionsaufruf geschrieben wurde.

Syntax

BOOL WINAPI SetConsoleTextAttribute(
  _In_ HANDLE hConsoleOutput,
  _In_ WORD   wAttributes
);

Parameter

hConsoleOutput [in]
Ein Handle für den Konsolenbildschirm-Puffer. Das Handle muss über das Zugriffsrecht GENERIC_READ verfügen. Weitere Informationen finden Sie unter Sicherheit und Zugriffsrechte für Konsolenpuffer.

wAttributes [in]
Die Zeichenattribute.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Um die aktuellen Farbattribute eines Bildschirmpuffers zu bestimmen, verwenden Sie die Funktion GetConsoleScreenBufferInfo.

Tipp

Diese API verfügt über eine virtuelle Terminal-Entsprechung in den Textformatierungs-Sequenzen. Virtuelle Terminalsequenzen werden für alle neuen und laufenden Entwicklungen empfohlen.

Beispiele

Für ein Beispiel siehe Verwenden der allgemeinen Eingabe- und Ausgabefunktionen.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Header	ConsoleApi2.h (über WinCon.h, Windows.h einschließen)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll