NI-SCOPE .NET Class Library Help

ScopeChannelMeasurement.BeginFetchComplexInt16 Method

  • Updated2023-09-06
  • 1 minute(s) read
ScopeChannelMeasurement.BeginFetchComplexInt16 Method

ScopeChannelMeasurementBeginFetchComplexInt16 Method

Begins an asynchronous retrieval of data from single channels and records.

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

Syntax

public IAsyncResult BeginFetchComplexInt16(
	PrecisionTimeSpan timeout,
	long numberOfSamples,
	ComplexWaveformCollection<ComplexInt16> waveforms,
	AsyncCallback callback,
	Object asyncState
)
Public Function BeginFetchComplexInt16 ( 
	timeout As PrecisionTimeSpan,
	numberOfSamples As Long,
	waveforms As ComplexWaveformCollection(Of ComplexInt16),
	callback As AsyncCallback,
	asyncState As Object
) As IAsyncResult

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.
callback
Type: SystemAsyncCallback
A delegate of type AsyncCallback, which will be invoked once the operation is complete.
asyncState
Type: SystemObject
The state of the asynchronous operation.

Return Value

Type: IAsyncResult
An IAsyncResult that represents the asynchronous fetch, which could still be pending.

See Also

Log in to get a better experience