FreeGPOListW function (userenv.h)

Article
02/09/2023

The FreeGPOList function frees the specified list of GPOs.

Syntax

USERENVAPI BOOL FreeGPOListW(
  [in] PGROUP_POLICY_OBJECTW pGPOList
);

Parameters

[in] pGPOList

A pointer to the list of GPO structures. This list is returned by the GetGPOList or GetAppliedGPOList function. For more information, see GROUP_POLICY_OBJECT.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Note

The userenv.h header defines FreeGPOList as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	userenv.h
Library	Userenv.lib
DLL	Userenv.dll