FPCRefs collection

Article
08/27/2012

Applies to: desktop apps only

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.

The FPCRefs collection can contain FPCRef objects that reference items with a specific scope and name. The scope indicates whether the item is defined for the array or for the enterprise. When an enterprise with central array management is deployed, 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.

Note Enterprise-level rule elements are available only in Forefront TMG Enterprise Edition.

The FPCRefs collection is used in various properties of the following objects.

Ff826013.bkbutton(en-us,VS.85).png Click here to see the Forefront TMG object hierarchy.

Members

The FPCRefs collection has these types of members:

Methods
Properties

Methods

The FPCRefs collection has these 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.
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.
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.
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 these properties.

Property	Access type	Description
_NewEnum	Read-only	Gets an enumerator object for the collection.
Count	Read-only	Gets the number of FPCRef objects in the collection.

Interfaces for C++ Programming

This collection implements the IFPCRefs and IFPCEERefs interfaces.

Examples

' 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

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