niFgen_ConfigureAmplitude
ViStatus niFgen_ConfigureAmplitude (ViSession vi, ViConstString channelName, ViReal64 amplitude);
Purpose
Configures the amplitude of the standard waveform that you want the signal generator to produce.
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 a standard waveform.
Default Value: "0" |
||
| amplitude | ViReal64 | Specifies the amplitude of the standard waveform that you want the signal generator to produce. This value is the amplitude at the output terminal. NI-FGEN sets the NIFGEN_ATTR_FUNC_AMPLITUDE attribute to this value.
For example, to produce a waveform ranging from –5.00 to +5.00 V, set the amplitude to 10.00 V.
Units: peak-to-peak voltage 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:
|