Microsoft Internet Security and Acceleration Server 2004 SDK

FPCWebFilter

The FPCWebFilter object represents a single Web filter that is registered to extend the ISA Server 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.

This object is typically an element of an FPCWebFilters collection.

Click here to see the ISA Server 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.

Methods

This object has no methods.

Properties

The FPCWebFilter object has the following properties.

Property Description
Description Gets or sets the vendor-supplied description of the Web filter.
Enabled Gets or sets a Boolean value that indicates whether the Web filter is enabled.
FilterDirection Gets a value from the FpcFilterDirection enumerated type that indicates whether the Web filter operates in reverse proxy, forward proxy, or both modes.
Guid Gets the vendor-supplied globally unique identifier (GUID) of the Web filter.
Name Gets or sets the vendor-supplied name of the Web filter.
Order 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 Gets or sets a value from the FpcFilterPriority enumerated type that specifies the priority of the Web filter.
RelativePath Gets or sets the path to the dynamic-link library (DLL) for the Web filter relative to the ISA Server installation directory.
Vendor Gets or sets the name of the vendor that supplied the Web filter.
Version 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.
VendorParametersSets Gets an FPCVendorParametersSets object that can hold sets of custom data for extending the object.

Remarks

This object implements the IFPCWebFilter interface.

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

COM Objects