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

Kopiert eine Anzahl von Zeichen aus aufeinander folgenden Zellen eines Konsolenbildschirmpuffers, beginnend an einer angegebenen Position.

Syntax

BOOL WINAPI ReadConsoleOutputCharacter(
  _In_  HANDLE  hConsoleOutput,
  _Out_ LPTSTR  lpCharacter,
  _In_  DWORD   nLength,
  _In_  COORD   dwReadCoord,
  _Out_ LPDWORD lpNumberOfCharsRead
);

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.

lpCharacter [out]
Ein Zeiger auf einen Puffer, der die aus dem Konsolenbildschirmpuffer gelesenen Zeichen empfängt.

nLength [in]
Die Anzahl der Bildschirmpufferzeichenzellen, aus denen gelesen werden soll. Die Größe des Puffers, auf den der lpCharacter-Parameter verweist, sollte sein nLength * sizeof(TCHAR).

dwReadCoord [in]
Die Koordinaten der ersten Zelle im Konsolenbildschirmpuffer, aus der gelesen werden soll, in Zeichen. Das X-Element der COORD-Struktur ist die Spalte, und das Y-Element ist die Zeile.

lpNumberOfCharsRead [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 zu lesenden Zeichen über das Ende der angegebenen Bildschirmpufferzeile hinausgeht, werden Zeichen aus der nächsten Zeile gelesen. Wenn die Anzahl der zu lesenden Zeichen über das Ende des Konsolenbildschirmpuffers hinausgeht, werden die Zeichen bis zum Ende des Konsolenbildschirmpuffers gelesen.

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 virtuelle Terminalentsprechung. 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. Anwendungen, die über plattformübergreifende Dienstprogramme und Transporte wie SSH remoting werden, funktionieren möglicherweise nicht wie erwartet, wenn Sie diese API verwenden.

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	ReadConsoleOutputCharacterW (Unicode) und ReadConsoleOutputCharacterA (ANSI)