niFgen_WriteWaveformComplexF64
ViStatus niFgen_WriteWaveformComplexF64 (ViSession vi, ViConstString channelName, ViInt32 numberofSamples, niFgen_ComplexF64[] data, ViInt32 waveformHandle);
Purpose
Writes complex data to the waveform in onboard memory on devices with the NIFGEN_ATTR_OUTPUT_ENABLED attribute set to VI_TRUE and the NIFGEN_ATTR_OSP_DATA_PROCESSING_MODE attribute set to NIFGEN_VAL_OSP_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_SetWaveformNextWritePosition function.
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" |
| numberofSamples | ViInt32 | Specifies the number of samples to load into the waveform. Default Value: 0 |
| data | niFgen_ComplexF64[] | Specifies the array of data to load into the waveform. You must normalize the data points in the array to be between -1.00 and +1.00. The array must have at least as many elements as the value in the numberOfSamples parameter. |
| waveformHandle | ViInt32 | Specifies the handle of the arbitrary waveform previously allocated with niFgen_AllocateWaveform. |
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:
|