IGPMBackupDirEx::SearchBackups method (gpmgmt.h)

Article
10/13/2021

Executes a search for a GPMBackup object or an IGPMStarterGPOBackup interface according to the specified criteria, and returns a GPMBackupCollection or GPMStarterGPOBackupCollection object.

Syntax

HRESULT SearchBackups(
  [in]  IGPMSearchCriteria *pIGPMSearchCriteria,
  [out] VARIANT            *pvarBackupCollection
);

Parameters

[in] pIGPMSearchCriteria

Pointer to the criteria to be applied to the search.

[out] pvarBackupCollection

Pointer to the IGPMBackupCollection or IGPMStarterGPOBackupCollection interface that represent the IGPMBackup or IGPMStarterGPOBackup objects that are found by the search.

Return value

C++

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

JScript

Returns a reference to a GPMBackupCollection or GPMStarterGPOBackupCollection object.

VB

Returns a reference to a GPMBackupCollection or GPMStarterGPOBackupCollection object.

Remarks

An empty IGPMSearchCriteria interface or GPMSearchCriteria object has had no criteria added to it. Passing in an empty IGPMSearchCriteria interface or GPMSearchCriteria object will return all
information in the IGPMBackup or IGPMStarterGPOBackup interface.

Requirements

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