SetChannelMaximumValue Method

Summary

Sets the channel maximum value.

Syntax

C++

public bool SetChannelMaximumValue( 
   bool include, 
   int maximumValue 
)

Public Function SetChannelMaximumValue( _ 
   ByVal include As Boolean, _ 
   ByVal maximumValue As Integer _ 
) As Boolean

public: 
bool SetChannelMaximumValue(  
   bool include, 
   int maximumValue 
)

Parameters

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

maximumValue
New channel maximum value.

Return Value

true if the channel maximum value was updated successfully, false if an error occurred.

Remarks

This method sets the value of the "Channel Maximum Value" (5400,0112) 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 "Channel Maximum Value" (5400,0112) element that corresponds to this channel by setting include to false. In this case the maximumValue parameter is ignored.

Example

For an example, refer to WaveformGroupCount.

Requirements

Target Platforms