FillConsoleOutputAttribute Funktion

Artikel
12/21/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 klassischen Konsolendokument im Vergleich zum virtuellen Terminal .

Legt die Zeichenattribute für eine angegebene Anzahl von Zeichenzellen fest, beginnend mit den angegebenen Koordinaten in einem Bildschirmpuffer.

Syntax

BOOL WINAPI FillConsoleOutputAttribute(
  _In_  HANDLE  hConsoleOutput,
  _In_  WORD    wAttribute,
  _In_  DWORD   nLength,
  _In_  COORD   dwWriteCoord,
  _Out_ LPDWORD lpNumberOfAttrsWritten
);

Parameter

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

wAttribute [in]
Die Attribute, die beim Schreiben in den Konsolenbildschirmpuffer verwendet werden sollen. Weitere Informationen finden Sie unter Attribute.

nLength [in]
Die Anzahl der Zeichenzellen, die auf die angegebenen Farbattribute festgelegt werden sollen.

dwWriteCoord [in]
Eine COORD-Struktur , welche die Zeichenkoordinaten der ersten Zelle angibt, deren Attribute festgelegt werden sollen.

lpNumberOfAttrsWritten [out]
Ein Zeiger auf eine Variable, welche die Anzahl der tatsächlich geschriebenen Zeichen empfängt.

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

Wenn die Anzahl der Zeichenzellen, deren Attribute festgelegt werden sollen, über das Ende der angegebenen Zeile im Konsolenbildschirmpuffer hinausgeht, werden die Zellen der nächsten Zeile festgelegt. Wenn die Anzahl der zu schreibenden Zellen über das Ende des Konsolenbildschirmpuffers hinausgeht, werden die Zellen bis zum Ende des Konsolenbildschirmpuffers geschrieben.

Die Zeichenwerte an den Positionen, in die geschrieben wird, werden nicht geändert.

Tipp

Diese API wird nicht empfohlen und verfügt nicht über eine bestimmte virtuelle Terminalentsprechung. Das Ausfüllen des Bereichs außerhalb des sichtbaren Fensters wird nicht unterstützt und ist für den Verlaufsbereich des Terminals reserviert. Das Ausfüllen eines sichtbaren Bereichs mit neuem Text oder einer neuen Farbe erfolgt durch Bewegen des Cursors, Festlegen der neuen Attribute und anschließendes Schreiben des gewünschten Texts für diesen Bereich, wiederholte Zeichen bei Bedarf für die Länge des Fülllaufs. Es kann eine zusätzliche Cursorbewegung erforderlich sein, gefolgt vom Schreiben des gewünschten Texts zum Ausfüllen eines rechteckigen Bereichs. Es wird erwartet, dass die Clientanwendung ihren eigenen Speicher für das, was sich auf dem Bildschirm befindet, beibehalten und den Remotestatus nicht abfragen kann. Weitere Informationen finden Sie in der Dokumentation zu klassischen Konsolen und virtuellen Terminalen .

Anforderungen


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