Funzione EnumDesktopsA (winuser.h)

Articolo
08/27/2023

Enumera tutti i desktop associati alla stazione finestra specificata del processo chiamante. La funzione passa il nome di ogni desktop, a sua volta, a una funzione di callback definita dall'applicazione.

Sintassi

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

Parametri

[in, optional] hwinsta

Handle per la stazione finestra i cui desktop devono essere enumerati. Questo handle viene restituito dalla funzione CreateWindowStation, GetProcessWindowStation o OpenWindowStation e deve avere il diritto di accesso WINSTA_ENUMDESKTOPS. Per altre informazioni, vedere Sicurezza e diritti di accesso della stazione finestre.

Se questo parametro è NULL, viene utilizzata la stazione finestra corrente.

[in] lpEnumFunc

Puntatore a una funzione di callback EnumDesktopProc definita dall'applicazione.

[in] lParam

Valore definito dall'applicazione da passare alla funzione di callback.

Valore restituito

Se la funzione ha esito positivo, restituisce il valore diverso da zero restituito dalla funzione di callback a cui punta lpEnumFunc.

Se la funzione non è in grado di eseguire l'enumerazione, il valore restituito è zero. Chiamare GetLastError per ottenere informazioni estese sull'errore.

Se la funzione di callback ha esito negativo, il valore restituito è zero. La funzione di callback può chiamare SetLastError per impostare un codice di errore per il chiamante da recuperare chiamando GetLastError.

Commenti

La funzione EnumDesktops enumera solo i desktop per i quali il processo chiamante ha il diritto di accesso DESKTOP_ENUMERATE. Per altre informazioni, vedere Desktop Security and Access Rights.For more information, see Desktop Security and Access Rights.

La funzione EnumDesktops richiama ripetutamente la funzione di callback lpEnumFunc fino a quando l'ultimo desktop non viene enumerato o la funzione di callback restituisce FALSE.

Nota

L'intestazione winuser.h definisce EnumDesktops come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti


Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	winuser.h (include Windows.h)
Libreria	User32.lib
DLL	User32.dll