enumDesktopsA 函式 (winuser.h)

發行項
08/27/2023

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

語法

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

參數

[in, optional] hwinsta

要列舉桌面之視窗月臺的控制碼。這個控制碼是由 CreateWindowStation、 GetProcessWindowStation或 OpenWindowStation 函式傳回，而且必須具有WINSTA_ENUMDESKTOPS存取權限。如需詳細資訊，請參閱視窗月臺安全性和存取權限。

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

[in] lpEnumFunc

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

[in] lParam

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

傳回值

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

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

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

備註

EnumDesktops函式只會列舉呼叫進程具有DESKTOP_ENUMERATE存取權限的桌上型電腦。如需詳細資訊，請參閱桌面安全性和存取權限。

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

注意

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

規格需求


最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	winuser.h (包括 Windows.h)
程式庫	User32.lib
Dll	User32.dll