IGPMStarterGPOBackup::GenerateReport method (gpmgmt.h)

Article
02/22/2024

The GenerateReport method gets the report for the backup 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. The Result property contains a string of XML or HTML. The Status property contains a reference to an IGPMStatusMsgCollection.

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