EnumDesktopProc callback function

An application-defined callback function used with the EnumDesktops function. It receives a desktop name.

The DESKTOPENUMPROC type defines a pointer to this callback function. EnumDesktopProc is a placeholder for the application-defined function name.

Syntax

BOOL CALLBACK EnumDesktopProc(
  _In_ LPTSTR lpszDesktop,
  _In_ LPARAM lParam
);

Parameters

  • lpszDesktop [in]
    The name of the desktop.

  • lParam [in]
    An application-defined value specified in the EnumDesktops function.

Return value

To continue enumeration, the callback function must return TRUE. To stop enumeration, it must return FALSE.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winbase.h (include Windows.h)

See also

Desktops

Window Station and Desktop Functions