Função EnumDesktopWindows (winuser.h)

Artigo
03/04/2024

Enumera todas as janelas de nível superior associadas à área de trabalho especificada. Ele passa o identificador para cada janela, por sua vez, para uma função de retorno de chamada definida pelo aplicativo.

Sintaxe

BOOL EnumDesktopWindows(
  [in, optional] HDESK       hDesktop,
  [in]           WNDENUMPROC lpfn,
  [in]           LPARAM      lParam
);

Parâmetros

[in, optional] hDesktop

Um identificador para a área de trabalho cujas janelas de nível superior devem ser enumeradas. Esse identificador é retornado pela função CreateDesktop, GetThreadDesktop, OpenDesktop ou OpenInputDesktop e deve ter o acesso DESKTOP_READOBJECTS correto. Para obter mais informações, consulte Segurança da área de trabalho e Direitos de Acesso.

Se esse parâmetro for NULL, a área de trabalho atual será usada.

[in] lpfn

Um ponteiro para uma função de retorno de chamada EnumWindowsProc definida pelo aplicativo.

[in] lParam

Um valor definido pelo aplicativo a ser passado para a função de retorno de chamada.

Retornar valor

Se a função falhar ou não conseguir executar a enumeração, o valor retornado será zero.

Para obter informações de erro estendidas, chame GetLastError.

Você deve garantir que a função de retorno de chamada defina SetLastError se ela falhar.

Windows Server 2003 e Windows XP/2000: Se não houver janelas na área de trabalho, GetLastError retornará ERROR_INVALID_HANDLE.

Comentários

A função EnumDesktopWindows invoca repetidamente a função de retorno de chamada lpfn até que a última janela de nível superior seja enumerada ou a função de retorno de chamada retorne FALSE.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll
Conjunto de APIs	ext-ms-win-ntuser-windowstation-l1-1-0 (introduzido em Windows 8)