Fungsi SetConsoleCursorPosition

Artikel
12/13/2023

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 posisi kursor di buffer layar konsol yang ditentukan.

Sintaks

BOOL WINAPI SetConsoleCursorPosition(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwCursorPosition
);

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.

dwCursorPosition [in]
Struktur COORD yang menentukan posisi kursor baru, dalam karakter. Koordinat adalah kolom dan baris sel karakter buffer layar. Koordinat harus berada dalam batas 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

Posisi kursor menentukan di mana karakter yang ditulis oleh fungsi WriteFile atau WriteConsole, atau digaungkan oleh fungsi ReadFile atau ReadConsole, ditampilkan. Untuk menentukan posisi kursor saat ini, gunakan fungsi GetConsoleScreenBufferInfo.

Jika posisi kursor baru tidak berada dalam batas jendela buffer layar konsol, asal jendela berubah untuk membuat kursor terlihat.

Tip

API ini memiliki terminal virtual yang setara di bagian posisi kursor sederhana dan posisi kursor. Penggunaan urutan baris baru, pengembalian gerbong, backspace, dan kontrol tab juga dapat membantu dengan penempatan kursor.

Contoh

Misalnya, lihat Menggunakan Fungsi Input dan Output Tingkat Tinggi.

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

Bagikan melalui