FPCIpRangeSet Collection

The FPCIpRangeSet collection holds a set of FPCIpRangeEntry objects that define IP address ranges. This collection is used to specify the following sets of IP address ranges:

The ranges of IP addresses in a client configuration script that the Web browsers on Firewall clients can access directly, bypassing the Microsoft Firewall service.
The set of IP address ranges that define the Internal network or a user-defined network.
The static address pool from which a virtual private network (VPN) server can assign IP addresses to VPN clients and remote VPN servers connecting to it.
The dedicated IP addresses for remote VPN servers.

This collection can be accessed through the DirectIPDestinations property of an FPCClientAutoScript object, the IpRangeSet and Ipv6RangeSet properties of an FPCNetwork object, the VpnStaticAddressPoolEx property of an FPCServer object, and the RemoteServersDedicatedAddresses property of an FPCVpnNetworkConfiguration object. When an enterprise with central array management is deployed, this collection can also be accessed through the IpRangeSet and Ipv6RangeSet properties of an FPCEnterpriseNetwork object.

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

Methods

The FPCIpRangeSet collection defines the following methods.

Method	Description
Add	Creates a new FPCIpRangeEntry object in the collection and returns a reference to it.
IsIpInSet	Determines whether the specified IP address is included in any of the IP address ranges in the collection.
IsRangeContained	Determines whether the specified IP address range is contained within any of the IP address ranges in the collection.
IsRangeIntersect	Determines whether the specified IP address range intersects any of the IP address ranges in the collection.
Item	Retrieves the FPCIpRangeEntry object specified by its index or by the upper and lower bounds of its IP address range from the collection.
Remove	Removes the FPCIpRangeEntry object specified by its index or by the upper and lower bounds of its IP address range from the collection.
RemoveAll	Removes all of the FPCIpRangeEntry objects from the collection.

Properties

The FPCIpRangeSet collection defines the following properties.

Property	Description
_NewEnum	Gets an enumerator object for the collection.
Count	Gets the number of FPCIpRangeEntry 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 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 IFPCIpRangeSet interface.

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.