Export (0) Print
Expand All

IGPMBackup::GenerateReportToFile method

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


.GenerateReportToFile(
  gpmReportType,
  bstrTargetFilePath,
  ppIGPMResult,
  TargetFile
)

Parameters

gpmReportType [in]

Specifies whether the report is in XML or HTML.

bstrTargetFilePath [in]

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

ppIGPMResult [out]

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.

TargetFile [in]

Binary string that contains the path of the file in which the report is being saved.

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Redistributable

GPMC on Windows Server 2003 or Windows XP with SP1

Header

Gpmgmt.h

IDL

Gpmgmt.idl

DLL

Gpmgmt.dll

IID

IID_IGPMBackup is defined as D8A16A35-3B0D-416B-8D02-4DF6F95A7119

See also

IGPMBackup
IGPMBackupCollection
IGPMBackupDir

 

 

Show:
© 2014 Microsoft