Edit

Share via

IGPMRSOP::GenerateReport method (gpmgmt.h)

  • Article

The GenerateReport method generates a report on the RSoP data.

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 that allows the client to receive status notifications about the progress of report generation. If this parameter is not NULL, the call to GenerateReport is handled asynchronously. If this parameter is NULL the call to GenerateReport is handled synchronously and a pointer to a IGPMAsyncCancel interface is returned in pvarGPMCancel. This parameter must be NULL if the client should not receive asynchronous notifications.

[out, optional] pvarGPMCancel

Receives a pointer to an IGPMAsyncCancel interface that the client can use to cancel the report generation. This parameter is not returned when pvarGPMProgress is NULL.

[out] ppIGPMResult

Pointer to an IGPMResult. The Result property contains a binary 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

See also

IGPMRSOP