Fungsi GetConsoleCursorInfo

Penting

Dokumen ini menjelaskan fungsionalitas platform konsol yang tidak lagi menjadi bagian dari peta jalan ekosistem kami. Kami tidak menyarankan penggunaan konten ini dalam produk baru, tetapi kami akan terus mendukung penggunaan yang ada untuk masa depan yang tidak terbatas. Solusi modern pilihan kami berfokus pada urutan terminal virtual untuk kompatibilitas maksimum dalam skenario lintas platform. Anda dapat menemukan informasi selengkapnya tentang keputusan desain ini di konsol klasik vs. dokumen terminal virtual kami.

Mengambil informasi tentang ukuran dan visibilitas kursor untuk buffer layar konsol yang ditentukan.

Sintaks

BOOL WINAPI GetConsoleCursorInfo(
  _In_  HANDLE               hConsoleOutput,
  _Out_ PCONSOLE_CURSOR_INFO lpConsoleCursorInfo
);

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.

lpConsoleCursorInfo [out]
Penunjuk ke struktur CONSOLE_CURSOR_INFO yang menerima informasi tentang kursor 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

Tip

API ini tidak disarankan dan tidak memiliki terminal virtual yang setara. Keputusan ini sengaja menyelaraskan platform Windows dengan sistem operasi lain di mana pengguna diberikan kontrol penuh atas opsi presentasi ini. Aplikasi jarak jauh melalui utilitas lintas platform dan transportasi seperti SSH mungkin tidak berfungsi seperti yang diharapkan jika menggunakan API ini.

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

Baca juga

Fungsi Konsol

Buffer Layar Konsol

CONSOLE_CURSOR_INFO

SetConsoleCursorInfo