Share via


FPCSystemPolicy object

Applies to: desktop apps only

The FPCSystemPolicy object represents the system policy for an array. The system policy is defined by a set of policy rules, called system policy rules. A system policy rule is a predefined rule that allows specific types of requests from the Local Host network (the Forefront TMG computer) to reach specified destinations, or allows specific types of requests from specified sources to reach the Local Host network.

Each system policy rule is represented by an FPCPolicyRule object contained in the read-only FPCSystemPolicyRules collection accessed through the PolicyRules property of the FPCSystemPolicy object for the array.

Logging can be enabled or disabled for a system policy rule using the EnableLogging property of the applicable FPCPolicyRule object.

Each system policy rule also belongs to a predefined group of system policy rules that apply to a specific service and can be configured together. Such a group is called a system policy configuration group, which is represented by an FPCSystemPolicyConfigGroup object.

An instance of the FPCSystemPolicyConfigGroup object for a specific configuration group can be created by calling the CreateConfigurationGroupInstance method of the FPCSystemPolicy object for the array.

Some properties of a system policy rule can be modified by modifying the properties of the FPCSystemPolicyConfigGroup object representing the configuration group to which the system policy rule belongs. In particular, the Enabled property of this object can be used to enable or disable a system policy rule.

The FPCSystemPolicy object is accessed through the SystemPolicy property of an FPCArray object.

Ff826679.bkbutton(en-us,VS.85).png Click here to see the Forefront TMG object hierarchy.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Members

The FPCSystemPolicy object has these types of members:

  • Methods
  • Properties

Methods

The FPCSystemPolicy object has these methods.

Method Description
CreateConfigurationGroupInstance

Creates an instance of the FPCSystemPolicyConfigGroup object for the system policy configuration group requested and returns a reference to it.

 

Properties

The FPCSystemPolicy object has these properties.

Property Access type Description

PolicyRules

Read-only

Gets the FPCSystemPolicyRules collection of all of the system policy rules for the array.

 

Methods Inherited from FPCPersist

Name Description
CancelWaitForChanges Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML file.
GetServiceRestartMask Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile Recursively copies the values of all the properties of the object and of its subobjects from the specified XML file to persistent storage.
LoadDocProperties Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save Recursively writes the current values of all the properties of the object and its subobjects to persistent storage.
WaitForChanges Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

 

Properties Inherited from FPCPersist

Name Description
PersistentName Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This collection implements the IFPCSystemPolicy interface.

Requirements

Minimum supported client

Windows Vista, None supported

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

Forefront Threat Management Gateway (TMG) 2010

IDL

Msfpccom.idl

See also

COM Objects

 

 

Build date: 7/12/2010