IGPMStarterGPO interface

The IGPMStarterGPO interface supports methods that enable you to manage Starter Group Policy Objects (GPOs) in the directory service.

Note that you cannot use this interface to manage local GPOs (LGPOs).

You can instantiate a GPMStarterGPO object by creating a new one with a call to IGPMDomain2::CreateStarterGPO, retrieving an existing one with a call to IGPMDomain2::GetStarterGPO, or by searching for one with a call to IGPMDomain2::SearchStarterGPOs. After creating the object, you can query the GPO and set properties related to the GPO.

Members

The IGPMStarterGPO interface inherits from the IDispatch interface. IGPMStarterGPO also has these types of members:

Methods

The IGPMStarterGPO interface has these methods.

MethodDescription
Backup

Backs up the Starter GPO to the specified directory.

CopyTo

Copies the policy settings from the Starter GPO in the current domain to a new Starter GPO.

Delete

Deletes the Starter GPO from the directory service.

GenerateReport

Generates a report for a Starter GPO.

GenerateReportToFile

Generates a report for a Starter GPO and saves it to a file at a specified path.

GetSecurityInfo

Retrieves the set of permissions for the GPO, such as who is granted the rights to edit it.

Save

Saves all the Starter GPO settings in a single CAB file.

SetSecurityInfo

Sets the list of permissions for the GPO.

 

Properties

The IGPMStarterGPO interface has these properties.

PropertyDescription

Author

Name of the person who created the Starter GPO.

ComputerVersion

Version number of the computer configuration portion of the Starter GPO.

CreationTime

Time when the Starter GPO was created.

Description

Starter GPO comment or description.

DisplayName

Friendly display name of the Starter GPO. Starter GPOs are identified in the Directory Service by ID (GUID), not by friendly name.

ID

ID of the Starter GPO.

ModifiedTime

Time when the Starter GPO was last modified.

Product

Name of the product this Starter GPO is designed to manage.

StarterGPOVersion

Version number of the Starter GPO.

Type

Specifies the type of Starter GPO.

UserVersion

Version number of the user configuration portion of the Starter GPO.

 

Remarks

The GPMStarterGPO object is analogous to the GPMGPO2 object. The GPMStarterGPO object represents a single instance of a Starter Group Policy object (GPO).

The IGPMStarterGPO interface has three properties that do not have a counterpart in the IGPMGPO2 interface.

  • The Author property contains the name of who created the Template. This attribute is applicable to System Templates. For custom Templates this attribute will be blank. This attribute is read-only.
  • The Product property contains the name of the product that the Template is designed to manage. For example a Template might ship to configure MS Office. This attribute is applicable to System Templates. For custom Templates this attribute will be blank. This attribute is read-only.
  • The Type property is an enum value, GPMStarterGPOType, that specifies the type of the attribute. The Type may be either a system Starter Group Policy object or a custom Starter Group Policy object.

The Save method has no corresponding method in the IGPMGPO2 interface. The Save method will generate a CAB file containing all the contents of a single Starter GPO. The objective of this method is to allow a user to save a Starter GPO in a form that can be easily redistributed. There is no way to create a CAB file containing multiple Starter GPOs.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Gpmgmt.h

IDL

Gpmgmt.idl

DLL

Gpmgmt.dll

IID

IID_IGPMStarterGPO is defined as DFC3F61B-8880-4490-9337-D29C7BA8C2F0

See also

IDispatch
IGPM2
IGPMDomain2
IGPMStarterGPOBackup
IGPMStarterGPOCollection

 

 

Show:
© 2015 Microsoft