SetFilterLowFrequency Method

Summary

Sets the filter low frequency.

Syntax

C++

public bool SetFilterLowFrequency( 
   bool include, 
   double filterLowFrequency 
)

Public Function SetFilterLowFrequency( _ 
   ByVal include As Boolean, _ 
   ByVal filterLowFrequency As Double _ 
) As Boolean

public: 
bool SetFilterLowFrequency(  
   bool include, 
   double filterLowFrequency 
)

Parameters

include
True to insert the "Filter Low Frequency" (003A,0220) element (that corresponds to this channel) into the dataset and then set its value, false to delete the "Filter Low Frequency" (003A,0220) element (that corresponds to this channel) from the dataset.

filterLowFrequency
New filter low frequency.

Return Value

true if the filter low frequency was updated successfully, false if an error occurred.

Remarks

This method sets the value of the "Filter Low Frequency" (003A,0220) element that corresponds to this channel. Set include to true to force the method to insert the element if it does not already exist in the dataset.
This method can also be used to delete the "Filter Low Frequency" (003A,0220) element that corresponds to this channel by setting include to false. In this case the filterLowFrequency parameter is ignored.

Example

For an example, refer to WaveformGroupCount.

Requirements

Target Platforms