WriteConsoleOutput

Składnia

Argumenty

Argument	Opis
hConsoleOutput	Uchwyt do bufora ekranu konsoli. Uchwyt musi mieć dostęp GENERIC_WRITE.
lpBuffer	Dane zapisywane do bufora ekranu konsoli. Ten wskaźnik jest traktowany jako początek dwuwymiarowej tablicy struktur CHAR_INFO, których rozmiar jest określony przez argument dwBufferSize. Miejsce w pamięci na ten bufor jest alokowane na stercie dla procesu zajmującego 64 KB pamięci. Maksymalny rozmiar bufora zależy od użycia sterty.
dwBufferSize	Rozmiar bufora wskazywanego przez argument lpBuffer, w komórkach znaków.
dwBufferCoord	Współrzędne lewej górnej komórki wskazywanej przez argument lpBuffer.
lpWriteRegion	Wskaźnik do struktury SMALL_RECT. Przy przekazywaniu danych do funkcji na liście argumentów składowe struktury określają współrzędne lewego górnego i prawego górnego rogu prostokąta bufora ekranu konsoli do zapisania. Gdy funkcja zakończy swoje działanie, składowe struktury określają aktualnie używany prostokąt.

Zwracana wartość

Jeśli nie wystąpią błędy, zwracana wartość jest niezerowa, inaczej 0. Aby uzyskać szczegółowe informacje o błędzie, wywołaj funkcję _{» WinAPI ♦} GetLastError.

Dodatkowe informacje

Funkcja traktuje bufor źródłowy i bufor docelowy jako dwuwymiarowe tablice. Prostokąt wskazywany przez wartość argumentu lpWriteRegion określa rozmiar i lokalizację bloku danych do zapisania w buforze ekranu konsoli. Prostokąt o tych samych rozmiarach jest umieszczony w tablicy lpBuffer (lewa górna komórka ma współrzędne zawarte w argumencie dwBufferCoord). Dane z komórek, które są wspólne dla tego prostokąta i prostokąta bufora źródłowego (którego rozmiary są określone przez wartośc argumentu dwBufferSize) są zapisywane do docelowego prostokąta. Komórki w docelowym prostokącie, które znajdują się poza granicami bufora źródłowego nie zostaną zmienione (żadne dane bufora ekranu nie są dla nich dostępne do zapisania). Przed zwróceniem wartości przez tą funkcję składowe struktury wskazywanej przez argument lpWriteRegion są ustawiane na aktualny prostokąt bufora ekranu. Ten prostokąt pokazuje komórki w docelowym buforze, dla których istnieją odpowiednie komórki w buforze źródłowym. Funkcja obcina wymiary docelowego prostokąta do granic bufora ekranu konsoli. Jeśli cały obszar prostokąta określonego przez lpWriteRegion znajduje się poza granicami bufora ekranu konsoli lub jeśli prostokąt jest umieszczony poza granicami bufora źródłowego, żadne dane nie zostaną zapisane. W tym przypadku funkcja zakończy swoje działanie ze składowymi struktury wskazywanej przez argument lpWriteRegion ustawionych w taki sposób, że składowa Right będzie mniejsza od składowej Left lub składowa Bottom będzie mniejsza od składowej Top. Aby określić rozmiar bufora ekranu konsoli, wywołaj funkcję _{» WinAPI ♦} GetConsoleScreenBufferInfo. Ta funkcja nie zmienia pozycji kursora bufora ekranu konsoli. Ta funkcja używa 8-bitowych znaków Unicode z obecnej strony kodowej konsoli. Domyślna strona kodowa jest stroną kodową OEM. Do zmiany strony kodowej służą funkcje _{» WinAPI ♦} SetConsoleCP oraz _{» WinAPI ♦} SetConsoleOutputCP. Można również użyć polecenia  lub .

Wymagania

Minimalny system klienta	Windows 2000 Professional (tylko aplikacje biurowe).
Minimalny system serwera	Windows 2000 Server (tylko aplikacje biurowe).
Nagłówek	Wincon.h (dołącza Windows.h)
Biblioteka	Kernel32.lib
DLL	Kernel32.dll
UNICODE	WriteConsoleOutputW
ANSI	WriteConsoleOutputA

Linki zewnętrzne

• http://msdn.microsoft.com/en-us/library/windows/desktop/ms687404(v=vs.85).aspx