EnumDesktopsA 函式（winuser.h）

發行項
11/20/2024

列舉與呼叫進程的指定視窗月臺相關聯的所有桌面。函式會接著將每個桌面的名稱傳遞至應用程式定義的回呼函式。

語法

BOOL EnumDesktopsA(
  [in, optional] HWINSTA          hwinsta,
  [in]           DESKTOPENUMPROCA lpEnumFunc,
  [in]           LPARAM           lParam
);

參數

[in, optional] hwinsta

要列舉桌面之視窗月臺的句柄。此句柄是由 CreateWindowStation、GetProcessWindowStation或 OpenWindowStation 函式傳回，且必須具有WINSTA_ENUMDESKTOPS訪問許可權。如需詳細資訊，請參閱 Window Station Security and Access Rights。

如果此參數為 NULL，則會使用目前的視窗月臺。

[in] lpEnumFunc

應用程式定義 EnumDesktopProc 回呼函式的指標。

[in] lParam

要傳遞至回調函式的應用程式定義值。

傳回值

如果函式成功，它會傳回由 lpEnumFunc所指向的回調函式所傳回的非零值。

如果函式無法執行列舉，則傳回值為零。呼叫 getLastError ，以取得擴充的錯誤資訊。

如果回呼函式失敗，則傳回值為零。回呼函式可以呼叫 setLastError ，藉由呼叫 getLastError getLastError來設定要擷取的錯誤碼。

言論

EnumDesktops 函式只會列舉呼叫進程具有DESKTOP_ENUMERATE訪問許可權的桌面電腦。如需詳細資訊，請參閱 Desktop Security and Access Rights。

EnumDesktops 函式會重複叫用 lpEnumFunc 回呼函式，直到列舉最後一個桌面或回呼函式傳回 FALSE 為止。

注意

winuser.h 標頭會將 EnumDesktops 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

要求

要求	價值
最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
支援的最低伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平臺	窗戶
標頭	winuser.h （包括 Windows.h）
連結庫	User32.lib
DLL	User32.dll