Función EnumDesktopsA (winuser.h)

Artículo
11/20/2024

Enumera todos los escritorios asociados a la estación de ventana especificada del proceso de llamada. La función pasa el nombre de cada escritorio, a su vez, a una función de devolución de llamada definida por la aplicación.

Sintaxis

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

Parámetros

[in, optional] hwinsta

Identificador de la estación de ventanas cuyos escritorios se van a enumerar. La función CreateWindowStation, GetProcessWindowStationo OpenWindowStation y debe tener el derecho de acceso WINSTA_ENUMDESKTOPS. Para obtener más información, vea Derechos de acceso y seguridad de la estación de ventanas.

Si este parámetro es NULL, se usa la estación de ventana actual.

[in] lpEnumFunc

Puntero a una función de devolución de llamada EnumDesktop Proc definida por la aplicación.

[in] lParam

Valor definido por la aplicación que se va a pasar a la función de devolución de llamada.

Valor devuelto

Si la función se ejecuta correctamente, devuelve el valor distinto de cero devuelto por la función de devolución de llamada a la que apuntaba lpEnumFunc.

Si la función no puede realizar la enumeración, el valor devuelto es cero. Llame a getLastError para obtener información de error extendida.

Si se produce un error en la función de devolución de llamada, el valor devuelto es cero. La función de devolución de llamada puede llamar a SetLastError para establecer un código de error para que el autor de la llamada recupere llamando a GetLastError.

Observaciones

La función EnumDesktops enumera solo los escritorios para los que el proceso de llamada tiene el derecho de acceso DESKTOP_ENUMERATE. Para obtener más información, consulte Derechos de acceso y seguridad de escritorio.

La función EnumDesktops invoca repetidamente el lpEnumFunc función de devolución de llamada hasta que se enumera el último escritorio o la función de devolución de llamada devuelve FALSE.

Nota

El encabezado winuser.h define EnumDesktops como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	winuser.h (incluya Windows.h)
biblioteca de	User32.lib
DLL de	User32.dll