niHSDIO Fetch Waveform
Transfers acquired waveform data from device memory to PC memory. The data was acquired to onboard memory previously by the hardware after it was initiated.
If the number of samples specified in samples to read is not available after the time duration specified in max time milliseconds, this VI returns no data with a timeout error.
The fetch position can be modified by selecting the appropriate Fetch Relative To and Fetch Offset properties in the property node. The default Fetch Relative To value is Current Read Position. The default Offset value is 0.
The niHSDIO Fetch Waveform (U32) VI is not necessary if you use the niHSDIO Read Waveform VI, as the fetch is performed as part of that function.
Use the pull-down menu to select an instance of this VI.
1D U32
This instance of niHSDIO Fetch Waveform fetches the data as an array of unsigned 32-bit integers and returns the number of samples read.
 |
instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
 |
samples to read specifies the 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 niHSDIO Configure Acquisition Size. |
||||||
|
max time milliseconds specifies in milliseconds the time allotted for the VI to complete before returning a timeout error.
If you set the value to -1, the VI never times out. For single record operations, if you set this parameter to 0, the VI returns immediately with up to the number of samples specified in samples to read. Setting this parameter to 0 is not supported for multirecord acquisitions. 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. |
||||||
 |
error in describes error conditions that occur before this VI or function runs.
| ||||||
 |
record to fetch specifies which record you want to fetch from onboard memory. | ||||||
 |
instrument handle out passes a reference to your instrument session to the next VI. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
 |
data is the acquired waveform. | ||||||
 |
number of samples read returns the number of samples that were successfully acquired and transferred into data. | ||||||
 |
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
|
1D U16
This instance of niHSDIO Fetch Waveform fetches the data as an array of unsigned 16-bit integers and returns the number of samples read.
|
instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
|
samples to read specifies the 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 niHSDIO Configure Acquisition Size. |
||||||
|
max time milliseconds specifies in milliseconds the time allotted for the VI to complete before returning a timeout error.
If you set the value to -1, the VI never times out. For single record operations, if you set this parameter to 0, the VI returns immediately with up to the number of samples specified in samples to read. Setting this parameter to 0 is not supported for multirecord acquisitions. 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. |
||||||
|
error in describes error conditions that occur before this VI or function runs.
| ||||||
|
record to fetch specifies which record you want to fetch from onboard memory. | ||||||
|
instrument handle out passes a reference to your instrument session to the next VI. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
 |
data contains the data for the waveform. | ||||||
|
number of samples read returns the number of samples that were successfully acquired and transferred into data. | ||||||
|
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
|
1D U8
This instance of niHSDIO Fetch Waveform fetches the data as an array of unsigned 8-bit integers and returns the number of samples read.
|
instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
|
samples to read specifies the 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 niHSDIO Configure Acquisition Size. |
||||||
|
max time milliseconds specifies in milliseconds the time allotted for the VI to complete before returning a timeout error.
If you set the value to -1, the VI never times out. For single record operations, if you set this parameter to 0, the VI returns immediately with up to the number of samples specified in samples to read. Setting this parameter to 0 is not supported for multirecord acquisitions. 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. |
||||||
|
error in describes error conditions that occur before this VI or function runs.
| ||||||
|
record to fetch specifies which record you want to fetch from onboard memory. | ||||||
|
instrument handle out passes a reference to your instrument session to the next VI. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
 |
data contains the data for the waveform. | ||||||
|
number of samples read returns the number of samples that were successfully acquired and transferred into data. | ||||||
|
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
|
WDT
This instance of niHSDIO Fetch Waveform fetches the data using the waveform data type and returns the number of samples read.
|
timestamp type specifies whether the timestamp for the waveform data is relative or absolute. | ||||||
|
instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
|
samples to read specifies the 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 niHSDIO Configure Acquisition Size. |
||||||
|
max time milliseconds specifies in milliseconds the time allotted for the VI to complete before returning a timeout error.
If you set the value to -1, the VI never times out. For single record operations, if you set this parameter to 0, the VI returns immediately with up to the number of samples specified in samples to read. Setting this parameter to 0 is not supported for multirecord acquisitions. 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. |
||||||
|
error in describes error conditions that occur before this VI or function runs.
| ||||||
|
record to fetch specifies which record you want to fetch from onboard memory. | ||||||
|
instrument handle out passes a reference to your instrument session to the next VI. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
 |
data is the acquired waveform. | ||||||
|
number of samples read returns the number of samples that were successfully acquired and transferred into data. | ||||||
|
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
|
2D U32
This instance of niHSDIO Fetch Waveform fetches the data as a two-dimensional array of unsigned 32-bit integers and returns the number of samples read.
|
instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||||
|
samples to read specifies the 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 niHSDIO Configure Acquisition Size. |
||||||||
|
max time milliseconds specifies in milliseconds the time allotted for the VI to complete before returning a timeout error.
If you set the value to -1, the VI never times out. For single record operations, if you set this parameter to 0, the VI returns immediately with up to the number of samples specified in samples to read. Setting this parameter to 0 is not supported for multirecord acquisitions. 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. |
||||||||
|
error in describes error conditions that occur before this VI or function runs.
| ||||||||
|
starting record specifies the record at which you would like to start fetching data. | ||||||||
|
records to fetch specifies how many records you would like to fetch from onboard memory.
Entering -1 causes the VI to fetch all records. |
||||||||
|
instrument handle out passes a reference to your instrument session to the next VI. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||||
 |
data contains the data for the waveform. | ||||||||
 |
wfm info contains the absolute and relative timestamp for the operation, the dt, and the actual number of samples read.
| ||||||||
|
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
|
2D U16
This instance of niHSDIO Fetch Waveform fetches the data as a two-dimensional array of unsigned 16-bit integers and returns the number of samples read.
|
instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||||
|
samples to read specifies the 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 niHSDIO Configure Acquisition Size. |
||||||||
|
max time milliseconds specifies in milliseconds the time allotted for the VI to complete before returning a timeout error.
If you set the value to -1, the VI never times out. For single record operations, if you set this parameter to 0, the VI returns immediately with up to the number of samples specified in samples to read. Setting this parameter to 0 is not supported for multirecord acquisitions. 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. |
||||||||
|
error in describes error conditions that occur before this VI or function runs.
| ||||||||
|
starting record specifies the record at which you would like to start fetching data. | ||||||||
|
records to fetch specifies how many records you would like to fetch from onboard memory.
Entering -1 causes the VI to fetch all records. |
||||||||
|
instrument handle out passes a reference to your instrument session to the next VI. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||||
 |
data contains the data for the waveform. | ||||||||
|
wfm info contains the absolute and relative timestamp for the operation, the dt, and the actual number of samples read.
| ||||||||
|
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
|
2D U8
This instance of niHSDIO Fetch Waveform fetches the data as a two-dimensional array of unsigned 8-bit integers and returns the number of samples read.
|
instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||||
|
samples to read specifies the 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 niHSDIO Configure Acquisition Size. |
||||||||
|
max time milliseconds specifies in milliseconds the time allotted for the VI to complete before returning a timeout error.
If you set the value to -1, the VI never times out. For single record operations, if you set this parameter to 0, the VI returns immediately with up to the number of samples specified in samples to read. Setting this parameter to 0 is not supported for multirecord acquisitions. 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. |
||||||||
|
error in describes error conditions that occur before this VI or function runs.
| ||||||||
|
starting record specifies the record at which you would like to start fetching data. | ||||||||
|
records to fetch specifies how many records you would like to fetch from onboard memory.
Entering -1 causes the VI to fetch all records. |
||||||||
|
instrument handle out passes a reference to your instrument session to the next VI. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||||
 |
data contains the data for the waveform. | ||||||||
|
wfm info contains the absolute and relative timestamp for the operation, the dt, and the actual number of samples read.
| ||||||||
|
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
|
1D WDT
This instance of niHSDIO Fetch Waveform fetches the data as an array of waveform data type data and returns the number of samples read.
|
timestamp type specifies whether the timestamp for the waveform data is relative or absolute. | ||||||
|
instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
|
samples to read specifies the 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 niHSDIO Configure Acquisition Size. |
||||||
|
max time milliseconds specifies in milliseconds the time allotted for the VI to complete before returning a timeout error.
If you set the value to -1, the VI never times out. For single record operations, if you set this parameter to 0, the VI returns immediately with up to the number of samples specified in samples to read. Setting this parameter to 0 is not supported for multirecord acquisitions. 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. |
||||||
|
error in describes error conditions that occur before this VI or function runs.
| ||||||
|
starting record specifies the record at which you would like to start fetching data. | ||||||
|
records to fetch specifies how many records you would like to fetch from onboard memory.
Entering -1 causes the VI to fetch all records. |
||||||
|
instrument handle out passes a reference to your instrument session to the next VI. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||
 |
data contains the data for the waveform. | ||||||
|
actual samples read returns the number of samples read. | ||||||
|
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
|
Direct DMA
Transfers acquired waveform data from device memory directly to PC memory allocated by a Direct DMA-compatible device. The size of the sample that is transferred is determined by the the data width for your device.
|
instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||||
|
samples to read specifies the 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 niHSDIO Configure Acquisition Size. |
||||||||
|
max time milliseconds specifies in milliseconds the time allotted for the VI to complete before returning a timeout error.
If you set the value to -1, the VI never times out. For single record operations, if you set this parameter to 0, the VI returns immediately with up to the number of samples specified in samples to read. Setting this parameter to 0 is not supported for multirecord acquisitions. 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. |
||||||||
|
buffer address specifies the location for the buffer in memory at which to transfer acquired data. | ||||||||
|
buffer size specifies the size (in bytes) of the buffer in memory at which to transfer acquired data. | ||||||||
|
record to fetch specifies the record number to fetch. The records are zero-indexed. | ||||||||
|
error in describes error conditions that occur before this VI or function runs.
|
||||||||
|
instrument handle out passes a reference to your instrument session to the next VI. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI. | ||||||||
 |
offset to first sample specifies the offset of the first sample acquired within the specified buffer. Data transfered from device memory in 128 byte increments, so the first sample of the acquired data typically occurs at some offset from the start of the buffer when using a Reference trigger. | ||||||||
|
wfm info contains the absolute and relative timestamp for the operation, the dt, and the actual number of samples read.
|
||||||||
|
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
|