Fungsi SetConsoleCursorInfo
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.
Mengatur ukuran dan visibilitas kursor untuk buffer layar konsol yang ditentukan.
Sintaks
BOOL WINAPI SetConsoleCursorInfo(
_In_ HANDLE hConsoleOutput,
_In_ const CONSOLE_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 [in]
Penunjuk ke struktur CONSOLE_CURSOR_INFO yang menyediakan spesifikasi baru untuk kursor 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
Saat kursor buffer layar terlihat, tampilannya dapat bervariasi, mulai dari mengisi sel karakter sepenuhnya hingga muncul sebagai garis horizontal di bagian bawah sel. Anggota dwSize dari struktur CONSOLE_CURSOR_INFO menentukan persentase sel karakter yang diisi oleh kursor. Jika anggota ini kurang dari 1 atau lebih besar dari 100, SetConsoleCursorInfo gagal.
Tip
API ini memiliki terminal virtual yang setara di bagian visibilitas kursor dengan ^[[?25h urutan dan ^[[?25l .
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 |