Share via


FPCApplicationFilter object

Applies to: desktop apps only

The FPCApplicationFilter object represents a single application filter. Application filters work with the Microsoft Firewall service to intercept and process data. Application filters can access the data stream or datagrams associated with a session within the Firewall service. The filters are registered with the Firewall service and act in response to events detected by the service. An application filter can perform protocol-specific or system-specific tasks, such as authentication and checking for viruses.

The application filters that are associated with a protocol are specified by including references to the applicable FPCApplicationFilter objects in the FPCRefs collection held in the ApplicationFilters property of the FPCProtocolDefinition object.

The application filters that are installed on a Forefront TMG computer are registered with the Firewall service by including references to the applicable FPCApplicationFilter objects in the FPCRefs collection held in the InstalledApplicationFilters property of the FPCServer object.

The FPCApplicationFilter object is an element of an FPCApplicationFilters collection, and a new object representing an application filter can be created by calling the Add method of this collection.

Ff824194.bkbutton(en-us,VS.85).png 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 the object's data to and importing it from an XML document.

Members

The FPCApplicationFilter object has these types of members:

  • Properties

Properties

The FPCApplicationFilter object has these properties.

Property Access type Description

Description

Read/write

Gets or sets the vendor-supplied description of the application filter.

Enabled

Read/write

Gets or sets a Boolean value that indicates whether the application filter is enabled.

FilterSpecificFlags

Read/write

Gets or sets a 32-bit bitmask, in which each bit holds a filter-specific flag or a flag that is common to all application filters.

Guid

Read-only

Gets vendor-supplied string-formatted globally unique identifier (GUID) for the application filter.

Name

Read/write

Gets or sets the vendor-supplied name of the application filter.

Predefined

Read-only

Gets a Boolean value that indicates whether the application filter was installed with Forefront TMG and cannot be deleted.

Vendor

Read/write

Gets or sets the name of the company that wrote the application filter.

Version

Read/write

Gets or sets the vendor-supplied version of the application 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 IFPCApplicationFilter and IFPCApplicationFilter2 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