FPCURLSet Collection

The FPCURLSet collection holds a set of Uniform Resource Locators (URLs) that can be applied to rules that control HTTP traffic, including cache rules, routing rules, access rules, and system policy rules.

Each URL in a URL set may include a host name and a path. Wildcard characters are allowed. However, URLs containing a question mark (?) that are included in a URL set are ignored. A protocol (HTTP, HTTPS, or FTP) and a port number may be included, but these are ignored.

Hosts may be specified in any of the following formats:

FQDN (for example, www.northwindtraders.com).
DNS suffix (for example, *.net).
IP Address.
Wildcard character (*).

Paths may be specified in any of the following formats:

Full path (for example, default.htm).
Prefix (for example, /pictures/travel/* or /*).

Forefront TMG also provides the following predefined URL sets:

Microsoft Error Reporting Sites. A predefined URL set used to allow error reporting to specific Microsoft sites.
System Policy Allowed Sites. A predefined URL set used to allow access to trusted sites for maintenance and management.

For information on populating a URL set with a list of URLs from a text file, see Importing Lists from Text Files.

URL sets are specified in the following properties by including references to the applicable FPCURLSet collections in the FPCRefs collection held in these properties:

The URLSets property of the FPCAccessProperties object.
The URLSets property of the FPCCacheRule object.
The URLSets property of the FPCDestinations object.
The URLSets property of the FPCLinkTranslationRedirection object.
The URLSets property of the FPCRoutingRule object.
The URLSets property of the FPCSystemPolicyConfigGroup object.

The FPCURLSet collection is an element of an FPCURLSets collection, and a new URL set can be created by calling the Add method of the FPCURLSets collection.

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

Method	Description
Add	Adds a URL to the URL set.
Item	Retrieves a requested URL from the URL set.
Remove	Removes the specified URL from the URL set.

Properties

The FPCURLSet collection defines the following properties.

Property	Description
_NewEnum	Gets an enumerator object for the collection.
Count	Gets the number of URLs in the URL set.
Description	Gets or sets the description of the URL set.
Name	Gets or sets the name of the URL set.
Predefined	Gets a Boolean value that indicates whether the URL set is a predefined URL set 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 collection's properties and elements can be imported from the specified XML document.
Export	Writes the stored values of the collection's properties and elements to the specified XML document.
ExportToFile	Writes the stored values of the collection's properties and 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 the collection's properties and elements from the specified XML document to persistent storage.
ImportFromFile	Copies the values of the collection's properties and 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 the collection's properties and elements from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of the collection's properties and 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 IFPCURLSets 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.