GPDomain.RestoreStarterGpo Method (StarterGpoBackup, GPStatusMessageCollection)

 

Restores the Starter Group Policy object (GPO) from the specified Starter GPO backup and returns status.

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

Syntax

public StarterGpo RestoreStarterGpo(
    StarterGpoBackup starterGpoBackup,
    out GPStatusMessageCollection statusMessages
)

public:
StarterGpo^ RestoreStarterGpo(
    StarterGpoBackup^ starterGpoBackup,
    [OutAttribute] GPStatusMessageCollection^% statusMessages
)

member RestoreStarterGpo : 
        starterGpoBackup:StarterGpoBackup *
        statusMessages:GPStatusMessageCollection byref -> StarterGpo

Public Function RestoreStarterGpo (
    starterGpoBackup As StarterGpoBackup,
    <OutAttribute> ByRef statusMessages As GPStatusMessageCollection
) As StarterGpo

Parameters

• starterGpoBackup
  Type: Microsoft.GroupPolicy.StarterGpoBackup

  A StarterGpoBackup object that represents a Starter GPO backup on the file system.

• statusMessages
  Type: Microsoft.GroupPolicy.GPStatusMessageCollection

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

Return Value

Type: Microsoft.GroupPolicy.StarterGpo

Returns StarterGpo. The restored Starter GPO.

Exceptions

Exception	Condition
ArgumentNullException	starterGpoBackup is null.

Remarks

You can restore a Starter GPO only to the domain in which the Starter GPO was originally created. This is because the operation restores the Starter GPO with its original Starter GPO GUID and policy settings.

See Also

RestoreStarterGpo Overload
GPDomain Class
Microsoft.GroupPolicy Namespace

Return to top