StarterGpo.GenerateReportToFile Method (String, ReportType, GPStatusMessageCollection)

 

Generates a report for the Starter Group Policy object (GPO), saves it to a specified file, and returns status.

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

Syntax

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

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

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

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

Parameters

• filePath
  Type: System.String

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

• reportType
  Type: Microsoft.GroupPolicy.ReportType

  One of the ReportType values that specifies the type of 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
StarterGpo Class
Microsoft.GroupPolicy Namespace

Return to top