AddEnumFilter Method of the IFPCFilterExpressions Interface

  • Article

The AddEnumFilter method creates a new FPCFilterExpression object representing an enumeration value filter expression in the collection and returns a reference to it.

C++

Syntax

HRESULT AddEnumFilter(
  [in]  FpcFilterCriteria Criteria,
  [in]  FpcFilterCondition Condition,
  [in]  long Value,
        IFPCFilterExpression** ppNewFilterExpression
);

Parameters

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

    When the FilterType property of the collection is set to fpcSessionsFilter, the only valid value for this parameter is fpcFilterBySessionType.

    When the FilterType property of the collection is set to fpcLogViewerFilter, the following values are valid:

    • fpcFilterByAction
    • fpcFilterByAuthenticated
    • fpcFilterByBidirectional
    • fpcFilterByLogType
    • fpcFilterByObjectSource
    • fpcFilterByService

  • Condition
    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:

    • fpcEqual
    • fpcNotEqual

  • Value
    A 32-bit integer value (enumeration value) that, together with the Criteria and Condition parameters, forms the filter expression.

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

Return Value

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.

Visual Basic

Syntax

Function AddEnumFilter( _
  ByVal Criteria As FpcFilterCriteria, _
  ByVal Condition As FpcFilterCondition, _
  ByVal Value As Long _
) As FPCFilterExpression

Parameters

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

    When the FilterType property of the collection is set to fpcSessionsFilter, the only valid value for this parameter is fpcFilterBySessionType.

    When the FilterType property of the collection is set to fpcLogViewerFilter, the following values are valid:

    • fpcFilterByAction
    • fpcFilterByAuthenticated
    • fpcFilterByBidirectional
    • fpcFilterByLogType
    • fpcFilterByObjectSource
    • fpcFilterByService

  • Condition
    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:

    • fpcEqual
    • fpcNotEqual

  • Value
    A 32-bit integer value (enumeration value) that, together with the Criteria and Condition parameters, forms the filter expression.

Return Value

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 fpcSessionsFilter or fpcLogViewerFilter before running this method.

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.
DLL

Requires Msfpccom.dll.

See Also

FPCFilterExpressions

Send comments about this topic to Microsoft

Build date: 6/30/2010