Função GetAppliedGPOListA (userenv.h)

Artigo
03/03/2024

A função GetAppliedGPOList recupera a lista de GPOs aplicados ao usuário ou computador especificado.

Sintaxe

USERENVAPI DWORD GetAppliedGPOListA(
  [in]  DWORD                 dwFlags,
  [in]  LPCSTR                pMachineName,
  [in]  PSID                  pSidUser,
  [in]  GUID                  *pGuidExtension,
  [out] PGROUP_POLICY_OBJECTA *ppGPOList
);

Parâmetros

[in] dwFlags

Um valor que especifica o tipo de política. Esse parâmetro pode ser o valor a seguir.

GPO_LIST_FLAG_MACHINE

Recupera informações sobre a política do computador.

Se esse valor não for especificado, a função recuperará apenas as informações de política do usuário.

[in] pMachineName

Um ponteiro para o nome do computador remoto. O formato do nome é "\\computer_name". Se esse parâmetro for NULL, o nome do computador local será usado.

[in] pSidUser

Um valor que especifica o SID do usuário. Se pMachineName não for NULL e dwFlags especificar a política de usuário, pSidUser não poderá ser NULL.

Se pMachineName for NULL e pSidUser for NULL, o usuário será o usuário conectado no momento. Se pMachineName for NULL e pSidUser não for NULL, o usuário será representado por pSidUser no computador local. Para obter mais informações, consulte Identificadores de segurança.

[in] pGuidExtension

Um valor que especifica o GUID da extensão.

[out] ppGPOList

Um ponteiro que recebe a lista de estruturas de GPO. Para obter mais informações, consulte GROUP_POLICY_OBJECT.

Retornar valor

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS. Caso contrário, a função retornará um código de erro do sistema. Para obter uma lista completa de códigos de erro, consulte Códigos de erro do sistema ou o arquivo de cabeçalho WinError.h.

Comentários

Para liberar a lista de GPO quando terminar de processá-la, chame a função FreeGPOList .

Observação

O cabeçalho userenv.h define GetAppliedGPOList 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 Vista
Servidor mínimo com suporte	Windows Server 2008
Plataforma de Destino	Windows
Cabeçalho	userenv.h
Biblioteca	Userenv.lib
DLL	Userenv.dll