niHSDIO Read Waveform

NI Digital Waveform Generator/Analyzer

previous page next page

niHSDIO Read Waveform

Initiates a waveform acquisition on channels enabled for dynamic acquisition, waits to acquire the number of samples specified in samples to read, and returns the acquired data.

Use the pull-down menu to select an instance of this VI.

1D U32

This instance of niHSDIO Read Waveform returns the binary representation of the acquired waveform.

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.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
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.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

1D U16

This instance of niHSDIO Read Waveform returns the acquired waveform as an array of unsigned 16-bit data.

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.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
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.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

1D U8

This instance of niHSDIO Read Waveform returns the acquired waveform as an array of unsigned 8-bit data.

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.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
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.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

WDT

This instance of niHSDIO Read Waveform returns the acquired waveform data with the waveform data type.

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.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
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.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

2D U32

This instance of niHSDIO Read Waveform returns the acquired waveform as a two-dimensional array of unsigned 32-bit data.

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.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
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.
absolute timestamp returns the absolute timestamp for the operation.
relative timestamp specifies the relative timestamp for the operation.
dt returns the time between values in 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.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

2D U16

This instance of niHSDIO Read Waveform returns the acquired waveform as a two-dimensional array of unsigned 16-bit data.

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.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
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.
absolute timestamp returns the absolute timestamp for the operation.
relative timestamp specifies the relative timestamp for the operation.
dt returns the time between values in 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.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

2D U8

This instance of niHSDIO Read Waveform returns the acquired waveform as a two-dimensional array of unsigned 8-bit data.

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.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
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.
absolute timestamp returns the absolute timestamp for the operation.
relative timestamp specifies the relative timestamp for the operation.
dt returns the time between values in 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.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

1D WDT

This instance of niHSDIO Read Waveform returns the acquired waveform as an array of waveform data types.

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.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
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.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.
previous page start next page