IGPM2::GetBackupDirEx method (gpmgmt.h)

Article
02/22/2024

For a Group Policy object (GPO), the GetBackupDirEx method creates and returns a GPMBackupDirEx object, which you can use to access a GPMBackup or GPMBackupCollection object.

For a Starter Group Policy object, the GetBackupDirEx method creates and returns a GPMBackupDirEx object, which you can use to access a GPMStarterGPOBackup or GPMStarterGPOBackupCollection object.

Syntax

HRESULT GetBackupDirEx(
  [in]          BSTR            bstrBackupDir,
  [in]          GPMBackupType   backupDirType,
  [out, retval] IGPMBackupDirEx **ppIGPMBackupDirEx
);

Parameters

[in] bstrBackupDir

Required. The name of the file system directory containing the Group Policy object (GPO) backups. Note that the directory must already exist.

[in] backupDirType

Determines whether the back up is for a Starter Group Policy object or a Group Policy object.

[out, retval] ppIGPMBackupDirEx

Address of a pointer to the IGPMBackupDirEx interface.

Return value

C++

Returns S_OK if successful. Returns a failure code if an error occurs.

JScript

Returns a reference to a GPMBackupDirEx object.

VB

Returns a reference to a GPMBackupDirEx object.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	gpmgmt.h
DLL	Gpmgmt.dll