[C++]
The AddStringFilter method creates a new FPCFilterExpression object
representing a string filter expression in the collection and
returns a reference to it.
HRESULT AddStringFilter(
FpcFilterCriteria Criteria,
FpcFilterCondition Condition,
BSTR Value,
IFPCFilterExpression** ppNewFilterExpression
);
Parameters
- Criteria
- [in] 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
- [in] 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
- [in] 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 Values
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.
Remarks
The FilterType property of the collection must be set to
fpcSessionsFilter or fpcLogViewerFilter before running this
method.
[Visual Basic]
The AddStringFilter method creates a new FPCFilterExpression object
representing a string filter expression in the collection and
returns a reference to it.
Function AddStringFilter( _
ByVal Criteria As FpcFilterCriteria, _
ByVal Condition As FpcFilterCondition, _
ByVal Value As String _
) As FPCFilterExpression
Parameters
- Criteria
- [in] 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
- [in] 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
- [in] String value that, together with the Criteria and
Condition parameters, forms the filter expression.
Return Values
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.