Função EnumDesktopsA (winuser.h)

Artigo
11/20/2024

Enumera todas as áreas de trabalho associadas à estação de janela especificada do processo de chamada. A função passa o nome de cada área de trabalho, por sua vez, para uma função de retorno de chamada definida pelo aplicativo.

Sintaxe

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

Parâmetros

[in, optional] hwinsta

Um identificador para a estação de janela cujas áreas de trabalho devem ser enumeradas. Esse identificador é retornado pela função CreateWindowStation, GetProcessWindowStationou OpenWindowStation e deve ter o acesso WINSTA_ENUMDESKTOPS correto. Para obter mais informações, consulte de Segurança e Direitos de Acesso da Estação de Janela.

Se esse parâmetro for NULL, a estação de janela atual será usada.

[in] lpEnumFunc

Um ponteiro para um EnumDesktopProc definido pelo aplicativo função de retorno de chamada.

[in] lParam

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

Valor de retorno

Se a função for bem-sucedida, ela retornará o valor diferente de zero retornado pela função de retorno de chamada que foi apontada por lpEnumFunc.

Se a função não puder executar a enumeração, o valor retornado será zero. Chame GetLastError para obter informações de erro estendidas.

Se a função de retorno de chamada falhar, o valor retornado será zero. A função de retorno de chamada pode chamar SetLastError para definir um código de erro para o chamador recuperar chamando GetLastError.

Observações

A função EnumDesktops enumera somente as áreas de trabalho para as quais o processo de chamada tem o acesso DESKTOP_ENUMERATE correto. Para obter mais informações, consulte segurança da área de trabalho e direitos de acesso.

A função EnumDesktops invoca repetidamente a função de retorno de chamada lpEnumFunc até que a última área de trabalho seja enumerada ou a função de retorno de chamada retorne FALSE.

Nota

O cabeçalho winuser.h define EnumDesktops como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winuser.h (inclua Windows.h)
biblioteca	User32.lib
de DLL	User32.dll