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



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

Syntax

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

Example

For an example, refer to DicomDataSet.WaveformGroupCount.

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

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