Função GetTokenInformation (securitybaseapi.h)

Artigo
03/15/2023

A função GetTokenInformation recupera um tipo especificado de informações sobre um token de acesso. O processo de chamada deve ter direitos de acesso apropriados para obter as informações.

Para determinar se um usuário é membro de um grupo específico, use a função CheckTokenMembership . Para determinar a associação de grupo para tokens de contêiner de aplicativo, use a função CheckTokenMembershipEx .

Sintaxe

BOOL GetTokenInformation(
  [in]            HANDLE                  TokenHandle,
  [in]            TOKEN_INFORMATION_CLASS TokenInformationClass,
  [out, optional] LPVOID                  TokenInformation,
  [in]            DWORD                   TokenInformationLength,
  [out]           PDWORD                  ReturnLength
);

Parâmetros

[in] TokenHandle

Um identificador para um token de acesso do qual as informações são recuperadas. Se TokenInformationClass especificar TokenSource, o identificador deverá ter acesso TOKEN_QUERY_SOURCE. Para todos os outros valores TokenInformationClass , o identificador deve ter acesso TOKEN_QUERY.

[in] TokenInformationClass

Especifica um valor do tipo enumerado TOKEN_INFORMATION_CLASS para identificar o tipo de informação que a função recupera. Todos os chamadores que marcar o TokenIsAppContainer e o fazem retornar 0 também devem verificar se o token de chamador não é um token de representação de nível de identificação. Se o token atual não for um contêiner de aplicativo, mas for um token de nível de identidade, você deverá retornar AccessDenied.

[out, optional] TokenInformation

Um ponteiro para um buffer que a função preenche com as informações solicitadas. A estrutura colocada nesse buffer depende do tipo de informação especificado pelo parâmetro TokenInformationClass .

[in] TokenInformationLength

Especifica o tamanho, em bytes, do buffer apontado pelo parâmetro TokenInformation . Se TokenInformation for NULL, esse parâmetro deverá ser zero.

[out] ReturnLength

Um ponteiro para uma variável que recebe o número de bytes necessários para o buffer apontado pelo parâmetro TokenInformation . Se esse valor for maior que o valor especificado no parâmetro TokenInformationLength , a função falhará e não armazenará nenhum dado no buffer.

Se o valor do parâmetro TokenInformationClass for TokenDefaultDacl e o token não tiver um DACL padrão, a função definirá a variável apontada por ReturnLength como sizeof(TOKEN_DEFAULT_DACL) e definirá o membro DefaultDacl da estrutura TOKEN_DEFAULT_DACL como NULL.

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.

Requisitos


Cliente mínimo com suporte	Windows XP [aplicativos da área de trabalho \| aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2003 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	securitybaseapi.h (inclua Windows.h)
Biblioteca	Advapi32.lib
DLL	Advapi32.dll