IGPMBackup::GenerateReport method (gpmgmt.h)

Article
10/13/2021

Gets the report for the backup Group Policy object (GPO).

Syntax

HRESULT GenerateReport(
  [in]            GPMReportType gpmReportType,
  [in, optional]  VARIANT       *pvarGPMProgress,
  [out, optional] VARIANT       *pvarGPMCancel,
  [out]           IGPMResult    **ppIGPMResult
);

Parameters

[in] gpmReportType

Specifies whether the report is in XML or HTML.

[in, optional] pvarGPMProgress

Pointer to an IGPMAsyncProgress interface. If pvarGPMProgress is NULL, the call to GenerateReport is handled synchronously. If not NULL, the call to GenerateReport is handled asynchronously, and pvarGPMCancel returns a pointer to IGPMAsyncCancel .

[out, optional] pvarGPMCancel

Pointer to an IGPMAsyncCancel interface. A value for this parameter is returned only when pvarGPMProgress is specified and is not NULL.

[out] ppIGPMResult

Pointer to an IGPMResult interface. The Result property contains a string of XML or HTML. The Status property contains a reference to an IGPMStatusMsgCollection interface.

Return value

C++

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

JScript

Returns a reference to a GPMResult object.

VB

Returns a reference to a GPMResult object.

Requirements

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