niFgen_CalAdjustOscillatorFrequency
ViStatus niFgen_CalAdjustOscillatorFrequency (ViSession vi, ViReal64 desiredFrequency, ViReal64 measuredFrequency);
Purpose
Calculates calibration constants pertaining to the VCXO. During external calibration, you can generate sine waves and take measurements of the resulting output frequency. Pass the desired and measured frequencies to this function to allow NI-FGEN to calculate the appropriate calibration constants and store them in the onboard EEPROM when the calibration session is committed.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_InitExtCal function and identifies a particular instrument session. |
| desiredFrequency | ViReal64 | Specifies the expected frequency of the output waveform. |
| measuredFrequency | ViReal64 | Specifies the actual (measured) frequency of the output 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:
|