EnumDesktopsA-Funktion (winuser.h)

Artikel
08/27/2023

Listet alle Desktops auf, die der angegebenen Fensterstation des aufrufenden Prozesses zugeordnet sind. Die Funktion übergibt wiederum den Namen jedes Desktops an eine anwendungsdefinierte Rückruffunktion.

Syntax

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

Parameter

[in, optional] hwinsta

Ein Handle für die Fensterstation, deren Desktops aufgelistet werden sollen. Dieses Handle wird von der CreateWindowStation-, GetProcessWindowStation- oder OpenWindowStation-Funktion zurückgegeben und muss über das WINSTA_ENUMDESKTOPS-Zugriffsberechtigung verfügen. Weitere Informationen finden Sie unter Sicherheit und Zugriffsrechte für Window Station.

Wenn dieser Parameter NULL ist, wird die aktuelle Fensterstation verwendet.

[in] lpEnumFunc

Ein Zeiger auf eine anwendungsdefinierte EnumDesktopProc-Rückruffunktion .

[in] lParam

Ein anwendungsdefinierter Wert, der an die Rückruffunktion übergeben werden soll.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie den Wert ungleich null zurück, der von der Rückruffunktion zurückgegeben wird, auf die von lpEnumFunc verwiesen wurde.

Wenn die Funktion die Enumeration nicht ausführen kann, ist der Rückgabewert null. Rufen Sie GetLastError auf, um erweiterte Fehlerinformationen zu erhalten.

Wenn die Rückruffunktion fehlschlägt, ist der Rückgabewert null. Die Rückruffunktion kann SetLastError aufrufen, um einen Fehlercode festzulegen, den der Aufrufer durch Aufrufen von GetLastError abrufen soll.

Hinweise

Die EnumDesktops-Funktion listet nur die Desktops auf, für die der aufrufende Prozess über das DESKTOP_ENUMERATE Zugriffsrecht verfügt. Weitere Informationen finden Sie unter Desktopsicherheit und -zugriffsrechte.

Die EnumDesktops-Funktion ruft die Rückruffunktion lpEnumFunc wiederholt auf, bis der letzte Desktop aufgelistet ist oder die Rückruffunktion FALSE zurückgibt.

Hinweis

Der winuser.h-Header definiert EnumDesktops als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winuser.h (windows.h einschließen)
Bibliothek	User32.lib
DLL	User32.dll