WriteConsoleOutputCharacter 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.

Kopiert eine Reihe von Zeichen in aufeinander folgende Zellen eines Konsolenbildschirmpuffers, beginnend an einer angegebenen Position.

Syntax

BOOL WINAPI WriteConsoleOutputCharacter(
  _In_  HANDLE  hConsoleOutput,
  _In_  LPCTSTR lpCharacter,
  _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.

lpCharacter [in]
Die Zeichen, die in den Konsolenbildschirmpuffer geschrieben werden sollen.

nLength [in]
Die Anzahl der zu schreibenden Zeichen.

dwWriteCoord [in]
Eine COORD-Struktur, die die Zeichenkoordinaten der ersten Zelle im Konsolenbildschirmpuffer angibt, in die Zeichen geschrieben werden.

lpNumberOfCharsWritten [out]
Ein Zeiger auf eine Variable, die 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 Zeichen, in die geschrieben werden soll, ü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 Positionen, in die geschrieben wurde, 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 verfügt über eine virtuelle Terminal-Entsprechung in den Sequenzen Textformatierung und Cursorpositionierung. Bewegen Sie den Cursor an die Einfügeposition, wenden Sie die gewünschte Formatierung an, und schreiben Sie Text aus, um den Text auszufüllen. Es gibt keine Entsprechung zum Ausgeben von Text an einen Bereich, ohne auch die aktive Farbformatierung anzuwenden. Diese Entscheidung richtet die Windows-Plattform absichtlich an andere Betriebssysteme aus, bei denen die einzelne Clientanwendung erwartet wird, dass sie sich ihren eigenen gezeichneten Zustand für eine weitere Manipulation merken wird.

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
Unicode- und ANSI-Namen	WriteConsoleOutputCharacterW (Unicode) und WriteConsoleOutputCharacterA (ANSI)