niHSDIO_DeleteNamedWaveform

NI Digital Waveform Generator/Analyzer

niHSDIO_DeleteNamedWaveform

Specific Function

C Function Prototype

ViStatus niHSDIO_DeleteNamedWaveform (ViSession vi, ViConstString waveformName);

Purpose

Frees a named waveform space in onboard memory.

Note  This function releases onboard memory space previously allocated by either the niHSDIO_AllocateNamedWaveform or Write Named Waveform functions. Any future reference to the deleted waveform results in an error. However, previously written scripts that still reference the deleted waveform do not generate an error at initiation.

An error is generated if the waveform name is not allocated in onboard memory.

Parameters

Name Type Description
vi ViSession This handle identifies your instrument session. vi was obtained from niHSDIO_InitGenerationSession.
waveformName ViConstString Specifies the name of the waveform to delete.

Default Value: ""

Return Value