Fungsi GetConsoleOriginalTitle

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 asli untuk jendela konsol saat ini.

Sintaks

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

Parameter

lpConsoleTitle [out]
Penunjuk ke buffer yang menerima string null-terminated yang berisi judul asli.

nSize [in]
Ukuran buffer lpConsoleTitle , dalam karakter.

Nilai hasil

Jika nSize adalah nol, nilai yang dikembalikan adalah nol.

Jika fungsi berhasil, nilai yang dikembalikan adalah panjang judul konsol asli, 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 saat ini, gunakan fungsi GetConsoleTitle.

Untuk mengkompilasi aplikasi yang menggunakan fungsi ini, tentukan _WIN32_WINNT sebagai 0x0600 atau yang lebih baru. Untuk informasi selengkapnya, lihat Menggunakan Header Windows.

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.

Persyaratan


Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Header	ConsoleApi2.h (melalui WinCon.h, termasuk Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll
Nama Unicode dan ANSI	GetConsoleOriginalTitleW (Unicode) dan GetConsoleOriginalTitleA (ANSI)

Bagikan melalui