niFgen_ConfigureSampleRate
ViStatus niFgen_ConfigureSampleRate (ViSession vi, ViReal64 sampleRate);
Purpose
Configures the sample rate attribute, which determines the rate at which the signal generator produces arbitrary waveforms. When you configure the signal generator to produce an arbitrary sequence, this value is the sample rate for all arbitrary waveforms in the sequence.
 |
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 output mode to NIFGEN_VAL_OUTPUT_ARB, NIFGEN_VAL_OUTPUT_SEQ, or NIFGEN_VAL_OUTPUT_SCRIPT 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. |
| sampleRate | ViReal64 | Specifies the sample rate at which you want the signal generator to generate arbitrary waveforms. NI-FGEN sets the NIFGEN_ATTR_ARB_SAMPLE_RATE attribute to this value.
Units: samples/s 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:
|