niFgen_CreateWaveformI16
ViStatus niFgen_CreateWaveformI16 (ViSession vi, ViConstString channelName, ViInt32 waveformSize, ViInt16[] waveformDataArray, ViInt32* waveformHandle);
Purpose
Creates an onboard waveform from binary I16 data for use in Arbitrary Waveform or Arbitrary Sequence output mode. The waveformHandle returned can later be used for setting the active waveform, changing the data in the waveform, building sequences of waveforms, or deleting the waveform when it is no longer needed.
 |
Note You must call the niFgen_ConfigureOutputMode function to set the outputMode parameter to NIFGEN_VAL_OUTPUT_ARB or NIFGEN_VAL_OUTPUT_SEQ before calling this 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 name for which you want to create the waveform.
Default Value: "0" |
| waveformSize | ViInt32 | Specifies the size of the arbitrary waveform that you want created. The size must meet the following restrictions:
You can obtain these values from the maximumWaveformSize, minimumWaveformSize, and waveformQuantum parameters in the niFgen_QueryArbWfmCapabilities function. Default Value: None |
| waveformDataArray | ViReal64[] | Specifies the array of data you want to use for the new arbitrary waveform. The array must have at least as many elements as the value that you specify in waveformSize.
You must normalize the data points in the array to be between –1.00 and +1.00. Default Value: None |
| 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:
|