niFgen_ConfigureGain
- Updated2023-02-21
- 2 minute(s) read
ViStatus niFgen_ConfigureGain (ViSession vi, ViConstString channelName, ViReal64 gain);
Purpose
Configures the amount of gain to apply to the waveform.
 |
Notes The signal generator must not be in the Generating state when you call this function. |
| You must call the niFgen_ConfigureOutputMode function to set the outputMode parameter to NIFGEN_VAL_OUTPUT_ARB before calling this function. |
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init, niFgen_InitWithOptions, or niFgen_InitializeWithChannels functions and identifies a particular instrument session. |
| channelName | ViConstString | Specifies the channel name for which you want to configure the gain.
Default Value: "0" |
| gain | ViReal64 | Specifies the factor by which the signal generator scales the arbitrary waveforms in the sequence. When you create an arbitrary waveform, you must first normalize the data points to a range of –1.00 to +1.00. You can use this parameter to scale the waveform to other ranges. The gain is applied before the offset is added.
For example, to configure the output signal to range from –2.00 to +2.00 V, set gain to 2.00. Units: unitless Default Value: None |
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:
|