NI-SCOPE .NET Class Library Help

Table of Contents

ScopeChannelMeasurement.FetchComplexInt16 Method (PrecisionTimeSpan, Int64, ComplexWaveformCollection(ComplexInt16))

  • Updated2023-09-06
  • 2 minute(s) read
ScopeChannelMeasurement.FetchComplexInt16 Method (PrecisionTimeSpan, Int64, ComplexWaveformCollection(ComplexInt16))

ScopeChannelMeasurementFetchComplexInt16 Method (PrecisionTimeSpan, Int64, ComplexWaveformCollectionComplexInt16)

Retrieves data from single channels and records. A one-dimensional array of complex binary 16-bit waveforms.

Namespace:  NationalInstruments.ModularInstruments.NIScope
Assembly:  NationalInstruments.ModularInstruments.NIScope.Fx45 (in NationalInstruments.ModularInstruments.NIScope.Fx45.dll) Version: 2023

Syntax

public ComplexWaveformCollection<ComplexInt16> FetchComplexInt16(
	PrecisionTimeSpan timeout,
	long numberOfSamples,
	ComplexWaveformCollection<ComplexInt16> waveforms
)
Public Function FetchComplexInt16 ( 
	timeout As PrecisionTimeSpan,
	numberOfSamples As Long,
	waveforms As ComplexWaveformCollection(Of ComplexInt16)
) As ComplexWaveformCollection(Of ComplexInt16)

Parameters

timeout
Type: NationalInstrumentsPrecisionTimeSpan
The time to wait for data to be acquired. Using 0 for this parameter tells NI-SCOPE to fetch whatever is currently available. Using -1 for this parameter implies infinite timeout.
numberOfSamples
Type: SystemInt64
The maximum number of samples to fetch for each waveform. If the acquisition finishes with fewer points than requested, some instruments return partial data if the acquisition finished, was aborted, or a timeout of 0 was used. Use –1 for this parameter if you want to fetch all available samples. The method reads the actual record length and attempts to acquire all available samples. If it fails to complete within the timeout period, the method returns an error.
waveforms
Type: NationalInstrumentsComplexWaveformCollectionComplexInt16
An array of type ComplexWaveformCollectionTData.

Return Value

Type: ComplexWaveformCollectionComplexInt16
An array of type ComplexWaveformCollectionTData.

Exceptions

ExceptionCondition
ObjectDisposedExceptionFetchComplexInt16(PrecisionTimeSpan, Int64, ComplexWaveformCollectionComplexInt16) was called after the associated NIScope or ScopeDriverUtility object was disposed.
IviCDriverException The channel specified is not enabled.

- or -

The session is not configured to fetch complex measurements.

- or -

The underlying NI-SCOPE driver returned an error.

See Also

Log in to get a better experience