IGPMBackup::GenerateReportToFile method (gpmgmt.h)

The GenerateReportToFile method gets the report for the backup Group Policy object (GPO) and then saves the report to a file in a specified path.

Syntax

HRESULT GenerateReportToFile(
  [in]  GPMReportType gpmReportType,
  [in]  BSTR          bstrTargetFilePath,
  [out] IGPMResult    **ppIGPMResult
);

Parameters

[in] gpmReportType

Specifies whether the report is in XML or HTML.

[in] bstrTargetFilePath

Binary string that contains the path of the file in which the report is being saved. Use a null-terminated string.

[out] ppIGPMResult

Pointer to an IGPMResult interface. The Status property contains a reference to an IGPMStatusMsgCollection interface.

Note  The value of the Result property is indeterminate and should not be relied upon.
 

Return value

C++

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

JScript

Returns a reference to a GPMResult object.
Note  The value of the Result property is indeterminate and should not be relied upon.
 

VB

Returns a reference to a GPMResult object.
Note  The value of the Result property is indeterminate and should not be relied upon.
 

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

IGPMBackup

IGPMBackupCollection

IGPMBackupDir