FPCFilterExpressions Collection

The FPCFilterExpressions collection holds a set of FPCFilterExpression objects and defines a filter that you can apply to sessions or log content.

This collection is supplied as an [in] parameter to the ExecuteQuery method of the FPCSessionsMonitor collection and to the ExecuteQuery method of the FPCLogContent collection to specify the filter that will be used in the query.

The FPCFilterExpressions collection is not part of the object hierarchy based on the FPC root object and must be created separately. The following Microsoft Visual Basic Scripting Edition (VBScript) example creates an instance of the FPCFilterExpressions collection:

  Set filter = CreateObject("FPC.FPCFilterExpressions")

When creating the filter expressions collection in Visual Basic, use the following:

  Dim root As New FPCLib.FPCFilterExpressions

or

  Dim root As FPCLib.FPCFilterExpressions
  Set root = CreateObject("FPC.FPCFilterExpressions")

When creating the filter expressions collection in C++, you can use the following code to create the collection and a smart pointer to the IFPCFilterExpressions interface:

  HRESULT hr;
  FPCLib::IFPCFilterExpressionsPtr sipFilterExpressionsCol;
  hr = sipFilterExpressionsCol.CreateInstance("FPC.FPCFilterExpressions");

Methods

The FPCFilterExpressions collection defines the following methods.

Method	Description
AddDateFilter	Creates a new FPCFilterExpression object representing a date filter expression in the collection and returns a reference to it.
AddEnumFilter	Creates a new FPCFilterExpression object representing an enumeration value filter expression in the collection and returns a reference to it.
AddIPAddressFilter	Creates a new FPCFilterExpression object representing an IP address filter expression in the collection and returns a reference to it.
AddMultipleEnumFilter	Creates a new FPCFilterExpression object representing a filter expression for multiple enumeration values in the collection and returns a reference to it.
AddMultipleStringFilter	Creates a new FPCFilterExpression object representing a filter expression for a comma-delimited list of strings in the collection and returns a reference to it.
AddNumericFilter	Creates a new FPCFilterExpression object representing a numeric filter expression in the collection and returns a reference to it.
AddStringFilter	Creates a new FPCFilterExpression object representing a string filter expression in the collection and returns a reference to it.
Item	Retrieves the requested FPCFilterExpression object from the collection.
Remove	Removes the specified FPCFilterExpression object from the collection.

Properties

The FPCFilterExpressions collection defines the following properties.

Property	Description
_NewEnum	Gets an enumerator object for the collection.
Count	Gets the number of FPCFilterExpression objects in the collection.
FilterType	Gets or sets a value from the FpcFilterType enumerated type that specifies whether the collection defines a session filter or a log filter.

Interfaces for C++ Programming

This object implements the IFPCFilterExpressions and IFPCFilterExpressions2 interfaces.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.

See Also

COM Objects

Send comments about this topic to Microsoft

Build date: 6/30/2010