IFPCFilterExpressions2::AddMultipleStringFilter method

  • Article

Applies to: desktop apps only

The AddMultipleStringFilter method 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.

Syntax

HRESULT AddMultipleStringFilter(
  [in]   FpcFilterCriteria Criteria,
  [in]   FpcFilterCondition Condition,
  [in]   BSTR Value,
  [out]  IFPCFilterExpression **ppNewFilterExpression
);

FPCFilterExpressions.AddMultipleStringFilter( _
  ByVal Criteria As FpcFilterCriteria, _
  ByVal Condition As FpcFilterCondition, _
  ByVal Value As String, _
  ByRef ppNewFilterExpression As IFPCFilterExpression _
) As FPCFilterExpression

Parameters

  • Criteria [in]
    Required. Value from the FpcFilterCriteria enumerated type that specifies the parameter (criteria) used in the filter expression.

    The following values are valid:

    • fpcFilterByClientIP
    • fpcFilterByDestHost
    • fpcFilterByDestHostIP
    • fpcFilterByDestHostPort
    • fpcFilterByDestinationNetwork
    • fpcFilterByHeader
    • fpcFilterByHTTPCode
    • fpcFilterByInterface
    • fpcFilterByOriginalClientIP
    • fpcFilterByProtocol
    • fpcFilterByResultCode
    • fpcFilterByRule
    • fpcFilterBySourceNetwork
    • fpcFilterByThreatName
    • fpcFilterByUrl

  • Condition [in]
    Required. Value from the FpcFilterCondition enumerated type that specifies the required relationship between the parameter (criteria) and the value included in the filter expression. The following values are valid:

    • fpcOneOf
    • fpcNotOneOf

  • Value [in]
    String value containing a comma-delimited list of strings that, together with the Criteria and Condition parameters, forms the filter expression.

  • ppNewFilterExpression [out]
    Address of an interface pointer that on return points to the new IFPCFilterExpression interface created.

Return value

C++

This method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

VB

This method returns a reference to the FPCFilterExpression object if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

The FilterType property of the collection must be set to fpcLogViewerFilter before running this method.

Requirements

Minimum supported client

 Windows Vista

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

DLL

 Msfpccom.dll

See also

FPCFilterExpressions

 

 

Build date: 7/12/2010