niFgen_ConfigureGain
ViStatus niFgen_ConfigureGain (ViSession vi, ViConstString channelName, ViReal64 gain);
Purpose
Configures the amount of gain to apply to the waveform.
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 configure the gain.
Default Value: "0" |
| gain | ViReal64 | Specifies the factor by which the signal generator scales the arbitrary waveform data. When you create arbitrary waveforms, you must first normalize the data points to a range of –1.00 to +1.00 V. You can use this parameter to scale the arbitrary waveform to other ranges. NI-FGEN sets the NIFGEN_ATTR_ARB_GAIN attribute to this value.
For example, to configure the output signal to range from –2.00 to +2.00 V, set the gain to 2.00. Units: volts 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:
|