Read Multi Record (2D U8)
- Updated2023-02-17
- 3 minute(s) read
Read Multi Record (2D U8)
Returns the acquired waveform as a two-dimensional array of unsigned 8-bit integers.
Inputs/Outputs
session in
Instrument session obtained from the Initialize Acquisition Sessionnode, the Initialize Generation Sessionnode, or the Initialize External Calibrationnode.
samples to read
The specified number of samples to fetch.
If you specify a value for samples to read that is greater than the number of samples in the device memory, NI-HSDIO returns the samples that are acquired after max time milliseconds. Setting this parameter to -1 acquires the samples per record specified in the niHSDIO Configure Acquisition Sizenode.
maximum time (ms)
The time, in milliseconds, allotted for the node to complete before NI-HSDIO returns a timeout error.
If you set the value to -1, the node never times out. If you set this parameter to 0, the node returns immediately with up to the number of samples specified in samples to read.
If samples to read is greater than the number of samples in the device memory and all the available samples are acquired before a timeout, NI-HSDIO returns the available samples.
Default value: 10000
starting record
The record at which you want to start fetching data.
Default value: 0
records to fetch
The number of records you want to fetch from onboard memory.
Default value: -1
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Default value: No error
session out
Handle that identifies the session in all subsequent node calls.
The session out parameter is obtained from the Initialize Acquisition Sessionnode or the Initialize Generation Sessionnode.
data
The returned data for the waveform.
waveform info
The absolute and relative timestamp for the operation, the dt, and the actual number of samples read.
absolute timestamp
absolute timestamp returns the absolute timestamp for the operation.
relative timestamp
relative timestamp returns the relative timestamp for the operation.
dt
dt returns the time between values in the waveform.
actual samples read
The returned number of samples read.
reserved 1
reserved 1 is reserved for future use.
reserved 2
reserved 2 is reserved for future use.
error out
Error information.
The node produces this output according to standard error behavior.