EnumDesktopsA-Funktion (winuser.h)

Artikel
11/20/2024

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

Syntax

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

Parameter

[in, optional] hwinsta

Ein Ziehpunkt für die Fensterstation, deren Desktops aufgezählt werden sollen. Dieser Handle wird von der CreateWindowStation, GetProcessWindowStationoder OpenWindowStation-Funktion zurückgegeben und muss über das WINSTA_ENUMDESKTOPS Zugriffsrecht verfügen. Weitere Informationen finden Sie unter Window Station Security and Access Rights.

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 wurde, auf die von lpEnumFuncverwiesen 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 für den Aufrufer festzulegen, der abgerufen werden soll, indem GetLastErroraufgerufen wird.

Bemerkungen

Die EnumDesktops--Funktion listet nur die Desktops auf, für die der Aufrufvorgang über das DESKTOP_ENUMERATE Zugriffsrecht verfügt. Weitere Informationen finden Sie unter Desktop security and access rights.

Die EnumDesktops--Funktion ruft wiederholt die lpEnumFunc- Rückruffunktion auf, bis der letzte Desktop aufgezählt wird oder die Rückruffunktion FALSE zurückgibt.

Anmerkung

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

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	winuser.h (enthalten Windows.h)
Library	User32.lib
DLL-	User32.dll