IGPMBackupDir::SearchBackups method (gpmgmt.h)
Executes a search for
the GPMBackup object according to the specified criteria, and returns an
GPMBackupCollection object.
Syntax
HRESULT SearchBackups(
[in] IGPMSearchCriteria *pIGPMSearchCriteria,
[out] IGPMBackupCollection **ppIGPMBackupCollection
);
Parameters
[in] pIGPMSearchCriteria
Pointer to the criteria to apply to the search.
gpoDomain
Pointer to the criteria for a search for a domain name. The search property value is the domain name. The opEquals or opNotEquals operators are valid search criteria.
gpoID
Pointer to criteria for a search for a Group Policy object (GPO) ID. The search property value is the GPO ID. The opEquals or opNotEquals operators are valid search criteria.
gpoDisplayName
Pointer to criteria for a search for a GPO display name. The search property value is the GPO display name. The opEquals, opContains, or opNotContains operators are valid search criteria.
backupMostRecent
Pointer to criteria for a search for the most recent backup. The search property value is TRUE. The opEquals operator is the valid search criteria.
[out] ppIGPMBackupCollection
Address of a pointer to the IGPMBackupCollection interface that represents the IGPMBackup objects 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 object.VB
Returns a reference to a GPMBackupCollection object.Remarks
An empty GPMSearchCriteria has had no criteria added to it. Passing in an empty GPMSearchCriteria will return all
GPMBackup objects.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2008 |
| Target Platform | Windows |
| Header | gpmgmt.h |
| DLL | Gpmgmt.dll |