Função GetAppliedGPOListW (userenv.h)

Artigo
11/20/2024

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

Sintaxe

USERENVAPI DWORD GetAppliedGPOListW(
  [in]  DWORD                 dwFlags,
  [in]  LPCWSTR               pMachineName,
  [in]  PSID                  pSidUser,
  [in]  GUID                  *pGuidExtension,
  [out] PGROUP_POLICY_OBJECTW *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 da 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 estiver NULL e pSidUser estiver NULL, o usuário será o usuário conectado no momento. Se pMachineName estiver NULL e pSidUser não estiver 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.

Valor de retorno

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.

Observações

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

Nota

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 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 Vista
servidor com suporte mínimo	Windows Server 2008
da Plataforma de Destino	Windows
cabeçalho	userenv.h
biblioteca	Userenv.lib
de DLL	Userenv.dll

Consulte também

FreeGPOList

GROUP_POLICY_OBJECT

GetGPOList

Funções de política de grupo

Visão geral da política de grupo

Compartilhar via