SetChannelMinimumValue Method

Summary

Sets the channel minimum value.

Syntax

C++

public bool SetChannelMinimumValue( 
   bool include, 
   int minimumValue 
)

Public Function SetChannelMinimumValue( _ 
   ByVal include As Boolean, _ 
   ByVal minimumValue As Integer _ 
) As Boolean

public: 
bool SetChannelMinimumValue(  
   bool include, 
   int minimumValue 
)

Parameters

include
true to insert the "Channel Minimum Value" (5400,0110) element (that corresponds to this channel) into the dataset and then set its value, false to delete the "Channel Minimum Value" (5400,0110) element (that corresponds to this channel) from the dataset.

minimumValue
New channel minimum value.

Return Value

true if the channel minimum value was set successfully, false if an error occurred.

Remarks

This method sets the value of the "Channel Minimum Value" (5400,0110) 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.

Example

For an example, refer to WaveformGroupCount.

Requirements

Target Platforms