Fungsi GetConsoleTitle

Artikel
10/23/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.

Mengambil judul untuk jendela konsol saat ini.

Sintaks

DWORD WINAPI GetConsoleTitle(
  _Out_ LPTSTR lpConsoleTitle,
  _In_  DWORD  nSize
);

Parameter

lpConsoleTitle [out]
Penunjuk ke buffer yang menerima string null-terminated yang berisi judul. Jika buffer terlalu kecil untuk menyimpan judul, fungsi menyimpan sebanyak mungkin karakter judul seperti yang akan pas di buffer, berakhir dengan terminator null.

nSize [in]
Ukuran buffer yang ditujukkan oleh parameter lpConsoleTitle , dalam karakter.

Nilai hasil

Jika fungsi berhasil, nilai yang dikembalikan adalah panjang judul jendela konsol, dalam karakter.

Jika fungsi gagal, nilai yang dikembalikan adalah nol dan GetLastError mengembalikan kode kesalahan.

Keterangan

Untuk mengatur judul untuk jendela konsol, gunakan fungsi SetConsoleTitle. Untuk mengambil string judul asli, gunakan fungsi GetConsoleOriginalTitle.

Fungsi ini menggunakan karakter Unicode atau karakter 8-bit dari halaman kode konsol saat ini. Halaman kode konsol default awalnya ke halaman kode OEM sistem. Untuk mengubah halaman kode konsol, gunakan fungsi SetConsoleCP atau SetConsoleOutputCP. Konsumen warisan juga dapat menggunakan perintah chcp atau mode con cp select= , tetapi tidak disarankan untuk pengembangan baru.

Tip

API ini tidak disarankan dan tidak memiliki terminal virtual yang setara. Keputusan ini sengaja menyelaraskan platform Windows dengan sistem operasi lainnya. Aplikasi jarak jauh melalui utilitas lintas platform dan transportasi seperti SSH mungkin tidak berfungsi seperti yang diharapkan jika menggunakan API ini.

Contoh

Misalnya, lihat SetConsoleTitle.

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
Nama Unicode dan ANSI	GetConsoleTitleW (Unicode) dan GetConsoleTitleA (ANSI)

Bagikan melalui