SetChannelOffset Method

Summary

Sets the channel offset.

Syntax

C++

public bool SetChannelOffset( 
   bool include, 
   double channelOffset 
)

Public Function SetChannelOffset( _ 
   ByVal include As Boolean, _ 
   ByVal channelOffset As Double _ 
) As Boolean

public: 
bool SetChannelOffset(  
   bool include, 
   double channelOffset 
)

Parameters

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

channelOffset
New channel offset.

Return Value

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

Remarks

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

Example

For an example, refer to WaveformGroupCount.

Requirements

Target Platforms