This topic has not yet been rated - Rate this topic

FPCRefs Collection

Internet Security and Acceleration Server 2004/2006 SDK

The FPCRefs collection holds a set of FPCRef objects that reference a group of items used to define a rule or to specify the settings for a feature. The FPCRefs collection can contain references to user sets, computer sets, or URL sets, for example. Note that each instance of the FPCRefs collection contains a set of FPCRef objects that reference items of the same type. The type of items referenced by an FPCRefs collection is determined by the property through which it is accessed.

In ISA Server Enterprise Edition, the FPCRefs collection can contain FPCRef objects that reference items with a specific scope and name, and it provides additional methods for managing these objects. The scope indicates whether the item is defined for the array or for the enterprise. In Enterprise Edition, rule elements, such as computers, computer sets, content type sets, domain name sets, IP address ranges, protocol definitions, schedules, subnets, URL sets, and user sets can be defined on the array level or on the enterprise level.

The FPCRefs collection is used in various properties of the FPCAccessProperties, FPCCacheRule, FPCConnectionLimitPolicy, FPCHTTPCompressionConfiguration (introduced in ISA Server 2006), FPCNetworkSet, FPCProtocolDefinition, FPCRoutingRule, FPCSelectionIPs, FPCServerPublishingProperties, FPCSystemPolicyConfigGroup, FPCVpnConfiguration, FPCVpnQuarantineSettings, FPCWebListener, FPCWebListenerProperties, and FPCWebPublishingProperties objects. In Enterprise Edition, it is also used in properties of the FPCNetwork and FPCServer objects.

Click here to see the ISA Server object hierarchy.

Methods

The FPCRefs collection defines the following methods.

Method	Description
Add	Creates a new FPCRef object in the collection and returns a reference to it.
AddScopedItem	Creates a new FPCRef object for an item with a specific scope in the collection and returns a reference to it (available only in Enterprise Edition).
Exists	Returns a Boolean value that indicates whether the collection contains an FPCRef object that references the specified item.
ExistsScopedItem	Returns a Boolean value that indicates whether the collection contains an FPCRef object that references an item with the specified scope and name (available only in Enterprise Edition).
Item	Retrieves the requested FPCRef object from the collection.
Refresh	Recursively reads the values of all the properties of the collection and its elements, including the properties of its subobjects from persistent storage, overwriting any changes that were not saved.
Remove	Removes the specified FPCRef object from the collection.
RemoveAll	Removes all elements from the collection.
RemoveSpecified	Removes the FPCRef object that references the specified item from the collection.
RemoveSpecifiedScopedItem	Removes the FPCRef object that references an item with the specified scope and name from the collection (available only in Enterprise Edition).
Save	Recursively writes the values of the properties of the collection and its elements, including the properties of its subobjects to persistent storage.

Properties

The FPCRefs collection has the following properties.

Property	Description
_NewEnum	Gets an enumerator object for the collection.
Count	Gets the number of FPCRef objects in the collection.

Interfaces for C++ Programming

This collection implements the IFPCRefs interface. In Enterprise Edition, this collection also implements the IFPCEERefs interface.

Example Code [Visual Basic]

 ' Use the FPCRefs.Add method to add an FPCRef object reference to 
' a user set to the list of excluded user sets.
isaArray.ArrayPolicy.PolicyRules(1).AccessProperties.UserSets.Add "UserSet_1", fpcExclude

' Use the FPCRef.Name property to retrieve the name of the excluded 
' user set.
isaArray.ArrayPolicy.PolicyRules(1).AccessProperties.UserSets(1).Name

Requirements