FPCRef Object

The FPCRef object represents a reference to another object that is used in defining a rule or in specifying the settings for a feature.

An FPCRef object can reference an item 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 not available in Forefront TMG Medium Business Edition.

This object can be an element of an FPCRefs collection, and a new FPCRef object can be created by calling the Add method of this collection. The FPCRef objects contained in each instance of the FPCRefs collection reference items of the same type. The type of items referenced by the FPCRef objects in an FPCRefs collection is determined by the property through which the collection is accessed.

The FPCRef object is also held as a separate object that is not an element of an FPCRefs collection in the following properties:

Click here to see the Forefront TMG object hierarchy.

Methods

The FPCRef object defines the following methods.

Method Description

Refresh

Reads all of the object's properties from persistent storage, overwriting any changes that were not saved.

Save

Writes the current values of all of the object's properties to persistent storage.

Properties

The FPCRef object defines the following properties.

Property Description

IncludeStatus

Gets a value from the FpcIncludeStatus enumerated type that specifies whether the referenced item is included in or excluded from the list of items to which a rule applies.

Name

Gets the name of the item referenced by this object.

Scope

Gets a value from the FpcItemScope enumerated type that indicates whether the referenced item is defined on the array level or on the enterprise level.

Interfaces for C++ Programming

This object implements the IFPCRef and IFPCEERef interfaces.

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.

See Also

COM Objects


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.