Função EnumDesktopsA (winuser.h)
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, GetProcessWindowStation ou OpenWindowStation e deve ter o direito de acesso WINSTA_ENUMDESKTOPS. Para obter mais informações, consulte Segurança da Estação de Janela e Direitos de Acesso.
Se esse parâmetro for NULL, a estação de janela atual será usada.
[in] lpEnumFunc
Um ponteiro para uma função de retorno de chamada EnumDesktopProc definida pelo aplicativo.
[in] lParam
Um valor definido pelo aplicativo a ser passado para a função de retorno de chamada.
Valor retornado
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.
Comentários
A função EnumDesktops enumera apenas as áreas de trabalho para as quais o processo de chamada tem o direito de acesso DESKTOP_ENUMERATE. 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.
Observação
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 de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.
Requisitos
| 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 |