niFgen_AllocateWaveform
ViStatus niFgen_AllocateWaveform (ViSession vi, ViConstString channelName, ViInt32 waveformSize, ViInt32* waveformHandle);
Purpose
Specifies the size of a waveform so that it can be allocated in onboard memory before loading the associated data. Data can then be loaded in smaller chunks with the Write (Binary16)Waveform functions.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. |
| channelName | ViConstString | Specifies the channel name for which you want to allocate the waveform.
Default Value: "0" |
| waveformSize | ViInt32 | Specifies, in samples, the size of the waveform to allocate. |
| Output | ||
| Name | Type | Description |
| waveformHandle | ViInt32* | The handle that identifies the new waveform. This handle is used later when referring to this waveform. |
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|