GpoBackup.GenerateReportToFile Method (ReportType, String, GPStatusMessageCollection)

 

Generates a report for the GPO and saves it to the specified file and returns status.

Namespace:   Microsoft.GroupPolicy
Assembly:  Microsoft.GroupPolicy.Management (in Microsoft.GroupPolicy.Management.dll)

Syntax

public void GenerateReportToFile(
    ReportType reportType,
    string filePath,
    out GPStatusMessageCollection statusMessages
)

public:
void GenerateReportToFile(
    ReportType reportType,
    String^ filePath,
    [OutAttribute] GPStatusMessageCollection^% statusMessages
)

member GenerateReportToFile : 
        reportType:ReportType *
        filePath:string *
        statusMessages:GPStatusMessageCollection byref -> unit

Public Sub GenerateReportToFile (
    reportType As ReportType,
    filePath As String,
    <OutAttribute> ByRef statusMessages As GPStatusMessageCollection
)

Parameters

• reportType
  Type: Microsoft.GroupPolicy.ReportType

  One of the ReportType values that specifies the type of report.

• filePath
  Type: System.String

  The path of the file to which to save the report.

• statusMessages
  Type: Microsoft.GroupPolicy.GPStatusMessageCollection

  When this method returns, contains a GPStatusMessageCollection that holds status for the operation.

Exceptions

Exception	Condition
ArgumentException	filePath is an empty string (“”).
ArgumentNullException	filepath is null.

See Also

GenerateReportToFile Overload
GpoBackup Class
Microsoft.GroupPolicy Namespace

Return to top