FillConsoleOutputCharacter Funktion

Artikel
10/23/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 .

Schreibt ein Zeichen in den Konsolenbildschirmpuffer eine bestimmte Anzahl an Male, beginnend mit den angegebenen Koordinaten.

Syntax

BOOL WINAPI FillConsoleOutputCharacter(
  _In_  HANDLE  hConsoleOutput,
  _In_  TCHAR   cCharacter,
  _In_  DWORD   nLength,
  _In_  COORD   dwWriteCoord,
  _Out_ LPDWORD lpNumberOfCharsWritten
);

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.

cCharacter [in]
Das Zeichen, das in den Konsolenbildschirmpuffer geschrieben werden soll.

nLength [in]
Die Anzahl der Zeichenzellen, in die das Zeichen geschrieben werden soll.

dwWriteCoord [in]
Eine COORD-Struktur , welche die Zeichenkoordinaten der ersten Zelle angibt, in die das Zeichen geschrieben werden soll.

lpNumberOfCharsWritten [out]
Ein Zeiger auf eine Variable, welche die Anzahl der tatsächlich im Konsolenbildschirmpuffer 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 Zeichen, die geschrieben werden sollen, über das Ende der angegebenen Zeile im Konsolenbildschirmpuffer hinausgeht, werden Zeichen in die nächste Zeile geschrieben. Wenn die Anzahl der Zeichen, die geschrieben werden sollen, über das Ende des Konsolenbildschirmpuffers hinausgeht, werden die Zeichen bis zum Ende des Konsolenbildschirmpuffers geschrieben.

Die Attributwerte an den geschriebenen Positionen werden nicht geändert.

Diese Funktion verwendet entweder Unicodezeichen oder 8-Bit-Zeichen aus der aktuellen Codepage der Konsole. Die Codepage der Konsole wird zunächst standardmäßig auf die OEM-Codepage des Systems festgelegt. Um die Codepage der Konsole zu ändern, verwenden Sie die Funktionen SetConsoleCP oder SetConsoleOutputCP. Ältere Consumer können auch die chcp oder mode con cp select=-Befehle verwenden, aber sie werden für neue Entwicklungen nicht empfohlen.

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, wiederholt 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
Unicode- und ANSI-Namen	FillConsoleOutputCharacterW (Unicode) und FillConsoleOutputCharacterA (ANSI)