niSync_CalGetOscillatorVoltage

C Function Prototype

ViStatus niSync_CalGetOscillatorVoltage (ViSession vi, ViReal64* voltage);

Purpose

Reads the voltage that controls the oscillator frequency currently stored on the specified device's non-volatile onboard memory.

You can adjust the oscillator voltage using niSync_CalAdjustOscillatorVoltage during an external calibration session. Use this function in conjunction with other NI-Sync external calibration functions to determine if your device needs an external calibration session.

Note  
  • You do not need a calibration password to use this function. It can be invoked with an instrument handle created with either niSync_init or niSync_InitExtCal.
  • If you adjust the oscillator voltage using niSync_CalAdjustOscillatorVoltage as part of an open session, this function returns the new oscillator voltage value you set using niSync_CalAdjustOscillatorVoltage.

Parameters

Name Type Description
vi ViSession The session handle that you obtain from niSync_init or niSync_InitExtCal. The handle identifies a particular instrument session.

voltage ViReal64 Returns the oscillator voltage, in volts, currently stored in the device's non-volatile onboard memory.

Return Values