Share via


FPCStaticRoutes Object

The FPCStaticRoutes collection holds a set of FPCStaticRoute objects that define the static routes for a Forefront TMG array.

The FPCStaticRoutes collection is accessed through the StaticRoutes property of the FPCArray object.

Ff796860.bkbutton(en-us,MSDN.10).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 the persistent storage of an object's data. They include methods for exporting an object's data to and importing it from XML documents.

Methods

The FPCStaticRoutes object defines the following methods.

Method Description

Add

Creates a new FPCStaticRoute object in the collection and returns a reference to it.

Item

Retrieves the requested FPCStaticRoute object from the collection.

MoveDown

Moves the specified static route one step down the list of static routes, which corresponds to the order in which the static routes are tried.

MoveUp

Moves the specified static route one step up the list of static routes, which corresponds to the order in which the static routes are tried.

Remove

Removes the specified FPCStaticRoute object from the collection.

Properties

The FPCStaticRoutes object defines the following properties.

Property Description

_NewEnum

Gets an enumerator object for the collection.

Count

Gets the number of FPCStaticRoute 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 and its elements can be imported from the specified XML document.
Export Writes the stored values of all the properties of the collection and its elements to the specified XML document.
ExportToFile Writes the stored values of all the properties of the collection and its elements 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 Copies the values of all the properties of the collection and its elements from the specified XML document to persistent storage.
ImportFromFile Copies the values of all the properties of the collection and its elements 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 Reads the values of all the properties of the collection and its elements from persistent storage, overwriting any changes that have not been saved.
Save Writes the current values of all the properties of the collection and its elements to persistent storage.
WaitForChanges Registers to wait for an event indicating that the contents of the collection 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 object that can hold sets of custom data for extending the collection.

Interfaces for C++ Programming

This object implements the IFPCStaticRoutes interface.

Requirements

Client Requires Windows 7 or Windows Vista.
Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.
IDL

Declared in Msfpccom.idl.

See Also

COM Objects

Send comments about this topic to Microsoft

Build date: 6/30/2010