NI-DAQmx .NET Framework 4.0 API Reference

Timing.ConfigureHandshakingBurstExportClock Method

  • Updated2023-02-21
  • 2 minute(s) read
Timing.ConfigureHandshakingBurstExportClock Method
Determines when the DAQ device transfers data to a peripheral device, using the onboard sample clock of the DAQ device to control burst handshake timing and exporting that clock for use by the peripheral device.

Namespace:  NationalInstruments.DAQmx
Assembly:  NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.40.49302

Syntax

public void ConfigureHandshakingBurstExportClock(
	string sampleClockOutputTerminal,
	double rate,
	DigitalLevelPauseTriggerCondition pauseCondition,
	ReadyForTransferEventLevelActiveLevel level,
	SampleClockPulsePolarity pulsePolarity,
	SampleQuantityMode sampleMode,
	int samplesPerChannel
)
Public Sub ConfigureHandshakingBurstExportClock ( 
	sampleClockOutputTerminal As String,
	rate As Double,
	pauseCondition As DigitalLevelPauseTriggerCondition,
	level As ReadyForTransferEventLevelActiveLevel,
	pulsePolarity As SampleClockPulsePolarity,
	sampleMode As SampleQuantityMode,
	samplesPerChannel As Integer
)

Parameters

sampleClockOutputTerminal
Type: SystemString
The terminal to which to export the sample clock.
rate
Type: SystemDouble
The rate of the sample clock, in hertz.
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.
pulsePolarity
Type: NationalInstruments.DAQmxSampleClockPulsePolarity
The polarity of the exported sample clock.
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

ExceptionCondition
DaqExceptionThe 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. ConfigureHandshakingBurstExportClock(String, Double, DigitalLevelPauseTriggerCondition, ReadyForTransferEventLevelActiveLevel, SampleClockPulsePolarity, 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 ConfigureHandshakingBurstExportClock(String, Double, DigitalLevelPauseTriggerCondition, ReadyForTransferEventLevelActiveLevel, SampleClockPulsePolarity, SampleQuantityMode, Int32) to a subset of devices in the task, and you must apply ConfigureHandshakingBurstExportClock(String, Double, DigitalLevelPauseTriggerCondition, ReadyForTransferEventLevelActiveLevel, SampleClockPulsePolarity, SampleQuantityMode, Int32) to the task as a whole. You must call ConfigureHandshakingBurstExportClock(String, Double, DigitalLevelPauseTriggerCondition, ReadyForTransferEventLevelActiveLevel, SampleClockPulsePolarity, 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.

See Also

Log in to get a better experience