GetConsoleAliasesLength 函式

發行項
12/13/2023

重要

本文件說明已不再是生態系統藍圖一部分的控制台平臺功能。我們不建議您在新產品中使用此內容，但我們將繼續支持無限期的未來現有使用量。我們慣用的新式解決方案著重於 虛擬終端機序列 ，以在跨平臺案例中達到最大相容性。您可以在傳統 主控台與虛擬終端機 檔中找到此設計決策的詳細資訊。

擷取 GetConsoleAliases 函式所使用的緩衝區所需的大小。

語法

DWORD WINAPI GetConsoleAliasesLength(
  _In_ LPTSTR lpExeName
);

參數

lpExeName [in]
要擷取其控制台別名的可執行文件名稱。

傳回值

儲存為此可執行檔所定義之所有控制台別名所需的緩衝區大小，以位元組為單位。

備註

若要編譯使用此函式的應用程式，請將_WIN32_WINNT定義為 0x0501 或更新版本。如需詳細資訊，請參閱使用 Windows 標頭。

提示

不建議使用此 API，而且沒有 虛擬終端機 對等專案。此決策會刻意將 Windows 平臺與其他操作系統對齊，其中個別用戶端應用程式作為殼層或解釋器，預期會維護自己的使用者便利性功能，例如行讀和操作行為，包括別名和命令歷程記錄。透過跨平臺公用程式和 SSH 之類的傳輸進行遠端處理的應用程式在使用這個 API 時可能無法如預期般運作。

需求


最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
頁首	ConsoleApi3.h （透過 WinCon.h，包含 Windows.h）
程式庫	Kernel32.lib
DLL	Kernel32.dll
Unicode 和 ANSI 名稱	GetConsoleAliasesLengthW （Unicode）和 GetConsoleAliasesLengthA （ANSI）