StarterGpo.Backup Method (String, String, GPStatusMessageCollection)

 

Backs up the Starter Group Policy object (GPO) to the specified directory and returns status.

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

Syntax

public StarterGpoBackup Backup(
    string directory,
    string comment,
    out GPStatusMessageCollection statusMessages
)

public:
StarterGpoBackup^ Backup(
    String^ directory,
    String^ comment,
    [OutAttribute] GPStatusMessageCollection^% statusMessages
)

member Backup : 
        directory:string *
        comment:string *
        statusMessages:GPStatusMessageCollection byref -> StarterGpoBackup

Public Function Backup (
    directory As String,
    comment As String,
    <OutAttribute> ByRef statusMessages As GPStatusMessageCollection
) As StarterGpoBackup

Parameters

• directory
  Type: System.String

  The path to the backup directory.

• comment
  Type: System.String

  A comment to include with the Starter GPO backup. Specify null for no comment.

• statusMessages
  Type: Microsoft.GroupPolicy.GPStatusMessageCollection

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

Return Value

Type: Microsoft.GroupPolicy.StarterGpoBackup

Returns StarterGpoBackup. An object that represents the Starter GPO backup on the file system.

Exceptions

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

See Also

Backup Overload
StarterGpo Class
Microsoft.GroupPolicy Namespace

Return to top