Função GetUserObjectInformationA (winuser.h)
Recupera informações sobre a estação de janela especificada ou o objeto da área de trabalho.
Sintaxe
BOOL GetUserObjectInformationA(
[in] HANDLE hObj,
[in] int nIndex,
[out, optional] PVOID pvInfo,
[in] DWORD nLength,
[out, optional] LPDWORD lpnLengthNeeded
);
Parâmetros
[in] hObj
Um identificador para a estação de janela ou objeto da área de trabalho. Esse identificador é retornado pela função CreateWindowStation, OpenWindowStation, CreateDesktop ou OpenDesktop .
[in] nIndex
As informações a serem recuperadas. O parâmetro pode ser um dos valores a seguir.
Valor | Significado |
---|---|
|
Os sinalizadores de identificador. O parâmetro pvInfo deve apontar para uma estrutura USEROBJECTFLAGS . |
|
O tamanho do heap da área de trabalho, em KB, como um valor ULONG . O parâmetro hObj deve ser um identificador para um objeto de área de trabalho; caso contrário, a função falhará.
Windows Server 2003 e Windows XP/2000: Não há suporte para esse valor. |
|
TRUE se o parâmetro hObj for um identificador para o objeto da área de trabalho que está recebendo entrada do usuário.
FALSE caso contrário.
Windows Server 2003 e Windows XP/2000: Não há suporte para esse valor. |
|
O nome do objeto, como uma cadeia de caracteres. |
|
O nome do tipo do objeto, como uma cadeia de caracteres. |
|
A estrutura sid que identifica o usuário que está atualmente associado ao objeto especificado. Se nenhum usuário estiver associado ao objeto , o valor retornado no buffer apontado por lpnLengthNeeded será zero. Observe que SID é uma estrutura de comprimento variável. Normalmente, você fará uma chamada para GetUserObjectInformation para determinar o comprimento do SID antes de recuperar seu valor. |
[out, optional] pvInfo
Um ponteiro para um buffer para receber as informações do objeto.
[in] nLength
O tamanho do buffer apontado pelo parâmetro pvInfo , em bytes.
[out, optional] lpnLengthNeeded
Um ponteiro para uma variável que recebe o número de bytes necessários para armazenar as informações solicitadas. Se o valor dessa variável for maior que o valor do parâmetro nLength quando a função retornar, a função retornará FALSE e nenhuma das informações será copiada para o buffer pvInfo . Se o valor da variável apontada por lpnLengthNeeded for menor ou igual ao valor de nLength, todo o bloco de informações será copiado.
Valor retornado
Se a função for bem-sucedida, o valor retornado será diferente de zero.
Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.
Comentários
Observação
O cabeçalho winuser.h define GetUserObjectInformation 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
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-ansi-l1-1-0 (introduzido no Windows 10, versão 10.0.10240) |