niFgen_WriteNamedComplexWaveformI16
ViStatus niFgen_WriteNamedComplexWaveformI16 (ViSession vi, ViConstString channelName, ViConstString waveformName, ViInt32 size, NIComplexI16[] data);
Purpose
Writes complex binary data to the named waveform in onboard memory on devices with the OSP Enabled property set to VI_TRUE and the Data Processing Mode property set to Complex. The waveform handle passed in must have been created by a call to the niFgen_AllocateWaveform function or to one of the following niFgen Create Waveform functions:
- niFgen_CreateWaveformF64
- niFgen_CreateWaveformI16
- niFgen_CreateWaveformFromFileI16
- niFgen_CreateWaveformFromFileF64
- niFgen_CreateWaveformFromFileHWS
The write position and offset can be set by calling the niFgen_SetWaveformNextWritePositionfunction.
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 onto which the waveform data should be loaded.
Default Value: "0" |
| waveformName | ViConstString | Specifies the name to associate with the allocated waveform. |
| size | ViInt32 | Specifies the number of samples to load into the waveform.
Default Value: 0 |
| data | NIComplexI16 [] | Specifies the array of data to load into the waveform. The array must have at least as many elements as the value in size. |
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:
|