FPCAddressRange object

Applies to: desktop apps only

The FPCAddressRange object represents a range of IP addresses. The lower and upper bounds of the range are set when the object is created by the Add method of an FPCAddressRanges collection, and they can be modified by calling the SetIps method.

The IP address ranges that are included in or excluded from a set of IP addresses are specified by including references to the applicable FPCAddressRange objects in the FPCRefs collection held in the AddressRanges property of the FPCSelectionIPs object.

The FPCAddressRange object is an element of an FPCAddressRanges collection.

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 an object's data to and importing it from an XML document.

Members

The FPCAddressRange object has these types of members:

• Methods
• Properties

Methods

The FPCAddressRange object has these methods.

Method	Description
SetIps	Sets the lower and upper bounds of the IP address range.

 

Properties

The FPCAddressRange object has these properties.

Property	Access type	Description
Description	Read/write	Gets or sets the description of the IP address range.
IP_From	Read-only	Gets the lower bound of the IP address range.
IP_To	Read-only	Gets the upper bound of the IP address range.
Name	Read/write	Gets or sets the name of the IP address range.
Predefined	Read-only	Gets a Boolean value that indicates whether the address range is a predefined address range that was created during the installation of Forefront TMG and cannot be deleted.

 

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	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties 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 of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties 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 of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties 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 object that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCAddressRange and IFPCAddressRange2 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