FPCPolicyRules collection

Applies to: desktop apps only

The FPCPolicyRules collection provides access to a group of FPCPolicyRule objects. An individual FPCPolicyRule object in this collection represents an access rule, a server publishing rule, or a Web publishing rule. This collection can be used to define an array policy or an enterprise policy.

The FPCPolicyRules collection is an ordered collection. The rules appear in this collection in their order of application. This order can be modified by calling the MoveUp and MoveDown methods.

The FPCPolicyRules collection can be accessed through the PolicyRules property of the FPCArrayPolicy object.

When an enterprise with central array management is deployed, this collection can also be accessed through the PolicyRules property of an FPCPolicy object, which represents an enterprise policy. The set of policy rules in an FPCPolicyRules collection that is used to define an enterprise policy may include only access rules and a placeholder that specifies the ordinal position (Order) of the set of array policy rules within the set of enterprise policy rules when the enterprise policy is applied to an array. Server publishing rules and Web publishing rules cannot be created on the enterprise level.

Note  Enterprise-level policy rules can be created only in Forefront TMG Enterprise Edition.

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

Inheritance

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

Members

The FPCPolicyRules collection has these types of members:

  • Methods
  • Properties

Methods

The FPCPolicyRules collection has these methods.

Method Description
AddAccessRule

Creates a new FPCPolicyRule object representing an access rule in the collection and returns a reference to it.

AddServerPublishingRule

Creates a new FPCPolicyRule object representing a server publishing rule in the collection and returns a reference to it.

AddServerPublishingRuleWithScopedProtocol

Creates a new FPCPolicyRule object representing a server publishing rule for a protocol with a specific scope in the collection and returns a reference to it.

AddWebPublishingRule

Creates a new FPCPolicyRule object representing a Web publishing rule in the collection and returns a reference to it.

Item

Retrieves the requested FPCPolicyRule object from the collection.

MoveDown

Moves the specified rule down the list of rules, which corresponds to their order of application.

MoveUp

Moves the specified rule up the list of rules, which corresponds to their order of application.

Remove

Removes an FPCPolicyRule object from the collection.

 

Properties

The FPCPolicyRules collection has these properties.

Property Access type Description

_NewEnum

Read-only

Gets an enumerator object for the collection.

Count

Read-only

Gets the number of FPCPolicyRule objects in the collection.

 

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 properties of the collection, its elements, and their subobjects can be imported from the specified XML document.
Export Recursively writes the stored values of all the properties of the collection, its elements, and their subobjects to the specified XML document.
ExportToFile Recursively writes the stored values of all the properties of the collection, its elements, and their 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 collection, its elements, and their subobjects from the specified XML document to persistent storage.
ImportFromFile Recursively copies the values of all the properties of the collection, its elements, and their 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 collection, its elements, and their subobjects from persistent storage, overwriting any changes that have not been saved.
Save Recursively writes the current values of all the properties of the collection, its elements, and their 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 collection. 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 collection.

 

Interfaces for C++ Programming

This collection implements the IFPCPolicyRules and IFPCEEPolicyRules interfaces.

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