Fungsi GetConsoleScreenBufferInfo

Artikel
10/23/2023

Mengambil informasi tentang buffer layar konsol yang ditentukan.

Sintaks

BOOL WINAPI GetConsoleScreenBufferInfo(
  _In_  HANDLE                      hConsoleOutput,
  _Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

Parameter

hConsoleOutput [in]
Handel ke buffer layar konsol. Handel harus memiliki akses GENERIC_READ yang tepat. Untuk informasi selengkapnya, lihat Keamanan dan Hak Akses Buffer Konsol.

lpConsoleScreenBufferInfo [out]
Penunjuk ke struktur CONSOLE_SCREEN_BUFFER_INFO yang menerima informasi buffer layar konsol.

Nilai hasil

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Persegi panjang yang dikembalikan di anggota srWindow dari struktur CONSOLE_SCREEN_BUFFER_INFO dapat dimodifikasi dan kemudian diteruskan ke fungsi SetConsoleWindowInfo untuk menggulir buffer layar konsol di jendela, untuk mengubah ukuran jendela, atau keduanya.

Semua koordinat yang dikembalikan dalam struktur CONSOLE_SCREEN_BUFFER_INFO berada dalam koordinat sel karakter, di mana asal (0, 0) berada di sudut kiri atas buffer layar konsol.

Tip

API ini tidak memiliki terminal virtual yang setara. Penggunaannya mungkin masih diperlukan untuk aplikasi yang mencoba menggambar kolom, kisi, atau mengisi tampilan untuk mengambil ukuran jendela. Status jendela ini dikelola oleh TTY/PTY/Pseudoconsole di luar aliran aliran normal dan umumnya dianggap sebagai hak istimewa pengguna yang tidak dapat disesuaikan oleh aplikasi klien. Pembaruan dapat diterima di ReadConsoleInput.

Contoh

Misalnya, lihat Menggulir Jendela Buffer Layar.

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Header	ConsoleApi2.h (melalui WinCon.h, termasuk Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll

Share via