EnumDesktopWindows

The EnumDesktopWindows function enumerates all windows in a desktop by passing a handle to each window, in turn, to an application-defined callback function.

BOOL EnumDesktopWindows(
  HDESK hDesktop,   // handle to desktop to enumerate
  WNDENUMPROC lpfn, // points to application's callback function
  LPARAM lParam     // 32-bit value to pass to the callback function
);
 

Parameters

hDesktop

Handle to the desktop whose windows are to be enumerated. The CreateDesktop, OpenDesktop, and GetThreadDesktop functions return a desktop handle. If this parameter is NULL, the current desktop is used.

lpfn

Pointer to an application-defined EnumWindowsProc callback function.

lParam

Specifies a 32-bit application-defined value to be passed to the callback function.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The EnumDesktopWindows function repeatedly invokes the lpfn callback function until the last window is enumerated or the callback function returns FALSE.

QuickInfo

  Windows NT: Requires version 3.51 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in winuser.h.
  Import Library: Use user32.lib.

See Also

Window Stations and Desktops Overview, Window Station and Desktop Functions, CreateDesktop, EnumWindowsProc, GetThreadDesktop, OpenDesktop