Microsoft Internet Security and Acceleration Server 2004 SDK

FPCRoutingRules Collection

The FPCRoutingRules collection provides access to the set of FPCRoutingRule objects that represent the routing rules defined in an ISA Server array. Routing rules determine whether a Web proxy client request is sent directly to the Internet, to another upstream proxy server, or to an alternate destination.

By using the MoveUp and MoveDown methods, you can adjust the order in which the routing rules in the collection are applied.

When you install ISA Server, it configures a default routing rule. The default rule is initially configured so that all requested objects will be retrieved from the ISA Server cache. If the object is not in the cache, it will be retrieved directly from the Internet. The default routing rule is applied last, and its position in the list of rules cannot be changed. You can modify the default routing rule's action and how it redirects outgoing Web requests, but you cannot delete it.

The FPCRoutingRules collection is typically accessed through the RoutingRules property of an FPCNetworkConfiguration object.

Click here to see the ISA Server object hierarchy.

Inheritance

This collection 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 FPCRoutingRules collection defines the following methods.

Method	Description
Add	Creates a new FPCRoutingRule object, adds it to the collection, and returns a reference to it.
Item	Retrieves the requested FPCRoutingRule object from the collection.
MoveDown	Moves the specified routing rule one step down the list of rules, which corresponds to their order of application.
MoveUp	Moves the specified routing rule one step up the list of rules, which corresponds to their order of application.
Remove	Removes the specified FPCRoutingRule object from the collection.

Properties

The FPCRoutingRules collection has the following properties.

Property	Description
_NewEnum	Gets an enumerator object for the collection.
Count	Gets the number of FPCRoutingRule 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.
VendorParametersSets	Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the collection.

Remarks

This collection implements the IFPCRoutingRules interface.

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.