Fungsi GetConsoleAliases
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 semua alias konsol yang ditentukan untuk executable yang ditentukan.
Sintaks
DWORD WINAPI GetConsoleAliases(
_Out_ LPTSTR lpAliasBuffer,
_In_ DWORD AliasBufferLength,
_In_ LPTSTR lpExeName
);
Parameter
lpAliasBuffer [out]
Penunjuk ke buffer yang menerima alias.
Format data adalah sebagai berikut: Source1=Target1\0Source2=Target2\0... SourceN=TargetN\0, di mana N adalah jumlah alias konsol yang ditentukan.
AliasBufferLength [in]
Ukuran buffer yang diacu oleh lpAliasBuffer, dalam byte.
lpExeName [in]
File yang dapat dieksekusi yang aliasnya akan diambil.
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
Untuk menentukan ukuran yang diperlukan untuk buffer lpExeName, gunakan fungsi GetConsoleAliasesLength.
Untuk mengkompilasi aplikasi yang menggunakan fungsi ini, tentukan _WIN32_WINNT sebagai 0x0501 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 lain di mana aplikasi klien individu yang bertindak sebagai shell atau interpreter diharapkan untuk mempertahankan fungsionalitas kenyamanan penggunanya sendiri seperti membaca baris dan perilaku manipulasi termasuk alias dan riwayat perintah. 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 | ConsoleApi3.h (melalui WinCon.h, termasuk Windows.h) |
| Pustaka | Kernel32.lib |
| DLL | Kernel32.dll |
| Nama Unicode dan ANSI | GetConsoleAliasesW (Unicode) dan GetConsoleAliasesA (ANSI) |