Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
SetWaveformChannelNumber Method
See Also 
Leadtools.Dicom Namespace > DicomWaveformChannel Class : SetWaveformChannelNumber Method



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.
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.
Sets the channel number.

Syntax

Visual Basic (Declaration) 
Public Function SetWaveformChannelNumber( _
   ByVal include As Boolean, _
   ByVal channelNumber As Integer _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As DicomWaveformChannel
Dim include As Boolean
Dim channelNumber As Integer
Dim value As Boolean
 
value = instance.SetWaveformChannelNumber(include, channelNumber)
C# 
public bool SetWaveformChannelNumber( 
   bool include,
   int channelNumber
)
C++/CLI 
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.

Example

For an example, refer to DicomDataSet.WaveformGroupCount.

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 doesn’t 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.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features