EnumDesktopsA, fonction (winuser.h)

Article
08/27/2023

Énumère tous les bureaux associés à la station de fenêtre spécifiée du processus appelant. La fonction transmet le nom de chaque bureau, à son tour, à une fonction de rappel définie par l’application.

Syntaxe

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

Paramètres

[in, optional] hwinsta

Handle pour la station de fenêtre dont les bureaux doivent être énumérés. Ce handle est retourné par la fonction CreateWindowStation, GetProcessWindowStation ou OpenWindowStation , et doit avoir le droit d’accès WINSTA_ENUMDESKTOPS. Pour plus d’informations, consultez Sécurité et droits d’accès de la station Windows.

Si ce paramètre a la valeur NULL, la station de fenêtre actuelle est utilisée.

[in] lpEnumFunc

Pointeur vers une fonction de rappel EnumDesktopProc définie par l’application.

[in] lParam

Valeur définie par l’application à passer à la fonction de rappel.

Valeur retournée

Si la fonction réussit, elle retourne la valeur différente de zéro retournée par la fonction de rappel pointée par lpEnumFunc.

Si la fonction ne peut pas effectuer l’énumération, la valeur de retour est zéro. Appelez GetLastError pour obtenir des informations d’erreur étendues.

Si la fonction de rappel échoue, la valeur de retour est zéro. La fonction de rappel peut appeler SetLastError pour définir un code d’erreur que l’appelant doit récupérer en appelant GetLastError.

Remarques

La fonction EnumDesktops énumère uniquement les bureaux pour lesquels le processus appelant a le droit d’accès DESKTOP_ENUMERATE. Pour plus d’informations, consultez Sécurité du bureau et droits d’accès.

La fonction EnumDesktops appelle à plusieurs reprises la fonction de rappel lpEnumFunc jusqu’à ce que le dernier bureau soit énuméré ou que la fonction de rappel retourne FALSE.

Notes

L’en-tête winuser.h définit EnumDesktops comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winuser.h (inclure Windows.h)
Bibliothèque	User32.lib
DLL	User32.dll