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访问权限。有关详细信息，请参阅 Window Station 安全和访问权限。

如果此参数为 NULL，则使用当前窗口工作站。

[in] lpEnumFunc

指向应用程序定义的 EnumDesktopProc 回调函数的指针。

[in] lParam

要传递给回调函数的应用程序定义值。

返回值

如果函数成功，则返回 由 lpEnumFunc 指向的回调函数返回的非零值。

如果函数无法执行枚举，则返回值为零。调用 GetLastError 可获取扩展错误信息。

如果回调函数失败，则返回值为零。回调函数可以调用 SetLastError ，通过调用 GetLastError 为调用方设置要检索的错误代码。

注解

EnumDesktops 函数仅枚举调用进程具有DESKTOP_ENUMERATE访问权限的桌面。有关详细信息，请参阅桌面安全和访问权限。

EnumDesktops 函数重复调用 lpEnumFunc 回调函数，直到枚举最后一个桌面或回调函数返回 FALSE。

注意

winuser.h 标头将 EnumDesktops 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。有关详细信息，请参阅函数原型的约定。

要求


最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
目标平台	Windows
标头	winuser.h (包括 Windows.h)
Library	User32.lib
DLL	User32.dll