FPCWebFilter object

Applies to: desktop apps only

The FPCWebFilter object represents a single Web filter that is registered to extend the Forefront TMG Web proxy. Web filters are dynamic-link libraries (DLLs) that are loaded when the Web proxy is launched and stay in memory until it shuts down. After Web filters are loaded, they can be configured to receive a number of special filter-event notifications. These filter-event notifications are generated for each HTTP request that the Web proxy receives and for each response returned by an external Web server through the Web proxy.

The Web filters that are installed on a Forefront TMG computer are specified by including references to the applicable FPCWebFilter objects in the FPCRefs collection held in the InstalledWebFilters property of the FPCServer object.

This object is an element of an FPCWebFilters collection, and a new object representing a Web filter can be created by calling the Add method of this collection.

Click here to see the Forefront TMG object hierarchy.

Inheritance

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

Members

The FPCWebFilter object has these types of members:

• Properties

Properties

The FPCWebFilter object has these properties.

Property	Access type	Description
Description	Read/write	Gets or sets the vendor-supplied description of the Web filter.
Enabled	Read/write	Gets or sets a Boolean value that indicates whether the Web filter is enabled.
FilterDirection	Read-only	Gets a value from the FpcFilterDirection enumerated type that indicates whether the Web filter is invoked in the forward proxy scenario, in the reverse proxy scenario, or in both scenarios.
Guid	Read-only	Gets the vendor-supplied globally unique identifier (GUID) of the Web filter.
Name	Read/write	Gets or sets the vendor-supplied name of the Web filter.
Order	Read-only	Gets the ordinal position of the Web filter in the list of Web filters, which establishes the order in which Web filters of the same priority receive data.
Priority	Read/write	Gets or sets a value from the FpcFilterPriority enumerated type that specifies the priority of the Web filter.
RelativePath	Read/write	Gets or sets the path to the dynamic-link library (DLL) for the Web filter, including the file name of the DLL, relative to the Forefront TMG installation folder.
Vendor	Read/write	Gets or sets the name of the vendor that supplied the Web filter.
Version	Read/write	Gets or sets the vendor-supplied version of the filter.

 

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 object's properties can be imported from the specified XML document.
Export	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties 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 of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties 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 of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties 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 object. 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 object that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCWebFilter and IFPCWebFilter2 interfaces.

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

See also

COM Objects

 

 

Build date: 7/12/2010