FPCRuleElements Object

The FPCRuleElements object provides access to collections containing the definitions of elements that are used to define rules of various types for a Forefront TMG array or the enterprise. These rule elements include content type sets, schedules, protocol definitions, Web listeners, authentication schemes, user sets, and sets of various types of network entities. Many of the properties of the FPCRuleElements object are mirrored by items in the Forefront TMG Management toolbox. The configuration settings of each of these categories of rule elements are managed programmatically through the FPCRuleElements object. The FPCRuleElements object also provides access to collections containing definitions of all the alert-triggering events that can be signaled by Forefront TMG and its extensions (add-ins) and definitions of all the RADIUS servers for authenticating VPN and Web proxy clients in an array.

This object is accessed through the RuleElements property of an FPCArray object.

This object is also accessed through the RuleElements property of the FPCEnterprise object (not available in Forefront TMG Medium Business Edition). However, the FPCRuleElements object accessed through the RuleElements property of the FPCEnterprise object does not provide access to collections of definitions of authentication schemes, events, Radius servers, or Web listeners.

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.

Methods

The FPCRuleElements object does not define any methods.

Properties

The FPCRuleElements object defines the following properties.

Property	Description
AddressRanges	Gets an FPCAddressRanges collection that contains the IP address ranges defined in the array or the enterprise.
AuthenticationSchemes	Gets an FPCAuthenticationSchemes collection that contains the authentication schemes defined in the array.
Computers	Gets an FPCComputers collection that contains the computers defined in the array or the enterprise.
ComputerSets	Gets an FPCComputerSets collection that contains the computer sets defined in the array or the enterprise.
ContentTypeSets	Gets an FPCContentTypeSets collection that contains the content type sets defined in the array or the enterprise.
DomainNameSets	Gets an FPCDomainNameSets collection that contains the domain name sets defined in the array or the enterprise.
EventDefinitions	Gets an FPCEventDefinitions collection that contains the events defined in the array.
LdapMatchingPatterns	Gets an FPCLdapMatchingPatterns collection that contains an ordered set of the logon string patterns mapped to LDAP server sets in the array.
LdapServersSets	Gets an FPCLdapServersSets collection that contains the LDAP server sets defined in the array.
ProtocolDefinitions	Gets an FPCProtocolDefinitions collection that contains the definitions of all the protocols supported by the Microsoft Firewall service in the array or the enterprise.
RadiusServers	Gets an FPCRadiusServers collection that contains the RADIUS servers defined in the array.
Schedules	Gets an FPCSchedules collection that contains the schedules defined in the array or the enterprise.
ServerFarms	Gets an FPCServerFarms collection that contains the server farms defined in the array.
Subnets	Gets an FPCSubnets collection that contains the subnets defined in the array or the enterprise.
URLSets	Gets an FPCURLSets collection that contains the URL sets defined in the array or the enterprise.
UserSets	Gets an FPCUserSets collection that contains the user sets defined in the array or the enterprise.
WebListeners	Gets an FPCWebListeners collection that contains the Web listeners defined in 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 object implements the IFPCRuleElements, IFPCRuleElements2, and IFPCRuleElements3 interfaces.

Requirements

Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
IDL	Declared in Msfpccom.idl.