SetWaveformChannelNumber Method

Summary

Sets the channel number.

Syntax

C++

public bool SetWaveformChannelNumber( 
   bool include, 
   int channelNumber 
)

Public Function SetWaveformChannelNumber( _ 
   ByVal include As Boolean, _ 
   ByVal channelNumber As Integer _ 
) As Boolean

public: 
bool SetWaveformChannelNumber(  
   bool include, 
   int channelNumber 
)

Parameters

include
True to insert the Waveform Channel Number (003A, 0202) element (that corresponds to this channel) into the dataset and then set its value, false to delete the Waveform Channel Number (003A,0202) element (that corresponds to this channel) from the dataset.

channelNumber
New waveform channel number.

Return Value

True if the waveform channel number was updated successfully, false if an error occurred.

Remarks

This method sets the value of the "Waveform Channel Number" (003A,0202) 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 "Waveform Channel Number" (003A,0202) element that corresponds to this channel by setting include to true. In this case the channelNumber parameter is ignored.

Example

For an example, refer to WaveformGroupCount.

Requirements

Target Platforms