niHSDIO Allocate Named Waveform

NI Digital Waveform Generator/Analyzer

niHSDIO Allocate Named Waveform

Reserves waveform space in onboard memory and associates a waveform name with it. Individual waveforms are stored contiguously in onboard memory.

The name given to the waveform is the same name used in the niHSDIO Write Named Waveform VI to populate the waveform with data, as well as the waveform name referenced in scripts.

If space is unavailable to accommodate a waveform of size size in samples, an error is returned and no memory space is allocated.

This VI does not change any data on the device itself, but rather adds the named reference in software. Use the niHSDIO Write Named Waveform VI to fill the onboard memory with waveform data to be generated.

instrument handle identifies your instrument session. instrument handle was obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI.
waveform name represents the name to associate with the allocated waveform memory.

You should name waveforms using this VI under either of the following conditions:

  • You are using scripts
  • You want to download multiple waveforms into the hardware
size in samples specifies the number of samples to allocate for the named waveform.

The number of bits in the allocated samples differs depending on the device you are using.

Device Bits Per Sample
NI 654x 32
NI 655x 32
NI 656x 16 in SDR mode
8 in DDR mode
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.
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.
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.