AddStringFilter Method of the IFPCFilterExpressions Interface

The AddStringFilter method creates a new FPCFilterExpression object representing a string filter expression in the collection and returns a reference to it.

[C++]

Syntax

HRESULT AddStringFilter(
  [in]  FpcFilterCriteria Criteria,
  [in]  FpcFilterCondition Condition,
  [in]  BSTR 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 following values are valid:

  • fpcFilterByApplicationName
  • fpcFilterByClientComputerName
  • fpcFilterByClientUserName
  • fpcFilterByServername
  • fpcFilterBySourceNetwork

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

  • fpcFilterByClientAgent
  • fpcFilterByClientComputerName
  • fpcFilterByClientUserName
  • fpcFilterByDestHost
  • fpcFilterByDestinationNetwork
  • fpcFilterByDestinationProxy
  • fpcFilterByFilterInfo
  • fpcFilterByHeader
  • fpcFilterByInterface
  • fpcFilterByMimetype
  • fpcFilterByOperation
  • fpcFilterByPayload
  • fpcFilterByProtocol
  • fpcFilterByReferringServer
  • fpcFilterByRule
  • fpcFilterByServername
  • fpcFilterBySourceNetwork
  • fpcFilterBySourceProxy
  • fpcFilterByTransport
  • fpcFilterByUrl
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
  • fpcContains
  • fpcNotContains
  • fpcNotEqual
Value

String 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:

[Visual Basic]

Syntax

Function AddStringFilter( _
  ByVal Criteria As FpcFilterCriteria, _
  ByVal Condition As FpcFilterCondition, _
  ByVal Value As String _
) 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 following values are valid:

  • fpcFilterByApplicationName
  • fpcFilterByClientComputerName
  • fpcFilterByClientUserName
  • fpcFilterByServername
  • fpcFilterBySourceNetwork

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

  • fpcFilterByClientAgent
  • fpcFilterByClientComputerName
  • fpcFilterByClientUserName
  • fpcFilterByDestHost
  • fpcFilterByDestinationNetwork
  • fpcFilterByDestinationProxy
  • fpcFilterByFilterInfo
  • fpcFilterByHeader
  • fpcFilterByInterface
  • fpcFilterByMimetype
  • fpcFilterByOperation
  • fpcFilterByPayload
  • fpcFilterByProtocol
  • fpcFilterByReferringServer
  • fpcFilterByRule
  • fpcFilterByServername
  • fpcFilterBySourceNetwork
  • fpcFilterBySourceProxy
  • fpcFilterByTransport
  • fpcFilterByUrl
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
  • fpcContains
  • fpcNotContains
  • fpcNotEqual
Value

String 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 Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCFilterExpressions


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.

[an error occurred while processing this directive]