niHSDIO_AllocateNamedWaveform
Specific Function
C Function Prototype
ViStatus niHSDIO_AllocateNamedWaveform (ViSession vi, ViConstString waveformName, ViInt32 sizeInSamples);
Purpose
Reserves waveform space in onboard memory and associates a waveform name with it. Individual waveforms are stored contiguously in onboard memory.
 |
Notes The niHSDIO_AllocateNamedWaveform function sets aside onboard memory space and associates a string name with that space. The name given to the waveform is the same name used in the write named waveform functions, as well as the name used in scripts. |
| If not enough space is available to accommodate a waveform of size sizeInSamples, an error is returned and no memory space is created. | |
| This function does not change any data on the device itself, but rather adds the named reference in software. Use the write named waveform functions to fill the onboard memory with waveform data to be generated. |
Parameters
| Name | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| vi | ViSession | This handle identifies your instrument session. vi was obtained from niHSDIO_InitGenerationSession. | ||||||||
| waveformName | ViConstString | Specifies the string representing the name to associate with the allocated waveform memory. Default Value: "" |
||||||||
| sizeInSamples | ViInt32 | 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.
Default Value: 10000 |