Timing.ConfigureHandshakingBurstImportClock Method
- Updated2023-02-21
- 2 minute(s) read
TimingConfigureHandshakingBurstImportClock Method
Namespace: NationalInstruments.DAQmx
Assembly: NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.40.49302
Syntax
public void ConfigureHandshakingBurstImportClock( string signalSource, double rate, SampleClockActiveEdge activeEdge, DigitalLevelPauseTriggerCondition pauseCondition, ReadyForTransferEventLevelActiveLevel level, SampleQuantityMode sampleMode, int samplesPerChannel )
Public Sub ConfigureHandshakingBurstImportClock ( signalSource As String, rate As Double, activeEdge As SampleClockActiveEdge, pauseCondition As DigitalLevelPauseTriggerCondition, level As ReadyForTransferEventLevelActiveLevel, sampleMode As SampleQuantityMode, samplesPerChannel As Integer )
Parameters
- signalSource
- Type: SystemString
The source terminal of the sample clock. To use the internal clock of the device, set this value to Empty. - rate
- Type: SystemDouble
The rate of the sample clock, in hertz. - activeEdge
- Type: NationalInstruments.DAQmxSampleClockActiveEdge
The edges of the sample clock pulses on which to acquire or generate samples. - pauseCondition
- Type: NationalInstruments.DAQmxDigitalLevelPauseTriggerCondition
Specifies whether the task pauses while the trigger signal is high or low. - level
- Type: NationalInstruments.DAQmxReadyForTransferEventLevelActiveLevel
The active level for the data transfer event. - sampleMode
- Type: NationalInstruments.DAQmxSampleQuantityMode
The duration of the task. A task is either finite and stops once the specified number of samples has been acquired or generated, or it is continuous and continues to acquire or generate samples until the task is explicitly stopped. - samplesPerChannel
- Type: SystemInt32
The number of samples to acquire or generate for each channel in the task if sampleMode is FiniteSamples. If sampleMode is ContinuousSamples, NI-DAQmx uses this value to determine the buffer size.
Exceptions
| Exception | Condition |
|---|---|
| DaqException | The NI-DAQmx driver returned an error. |
Remarks
These devices support burst handshake timing for digital I/O.
The NI-DAQmx driver does not determine if the requested settings are possible until the task is verified. ConfigureHandshakingBurstImportClock(String, Double, SampleClockActiveEdge, DigitalLevelPauseTriggerCondition, ReadyForTransferEventLevelActiveLevel, SampleQuantityMode, Int32) does not throw an exception for parameter values that are not compatible with your hardware or other settings in your task. To determine if all of the settings for a Task are valid, you must verify the task by starting the task, either with Start or by reading from or writing to the task, or by calling Control(TaskAction) with Verify.
You cannot apply ConfigureHandshakingBurstImportClock(String, Double, SampleClockActiveEdge, DigitalLevelPauseTriggerCondition, ReadyForTransferEventLevelActiveLevel, SampleQuantityMode, Int32) to a subset of devices in the task, and you must apply ConfigureHandshakingBurstImportClock(String, Double, SampleClockActiveEdge, DigitalLevelPauseTriggerCondition, ReadyForTransferEventLevelActiveLevel, SampleQuantityMode, Int32) to the task as a whole. You must call ConfigureHandshakingBurstImportClock(String, Double, SampleClockActiveEdge, DigitalLevelPauseTriggerCondition, ReadyForTransferEventLevelActiveLevel, SampleQuantityMode, Int32) on the instance of Timing returned from the Timing property on the Task class. Accessing this method on instances of Timing returned from the ItemString property throws an exception.