niSync_CloseExtCal

C Function Prototype

ViStatus niSync_CloseExtCal (ViSession vi, ViInt32 action);

Purpose

Ends an external calibration session you began using niSync_InitExtCal.

When you set new calibration constants using an external calibration function such as niSync_CalAdjustClk10PhaseVoltage, niSync_CalAdjustDDSStartPulsePhaseVoltage, or niSync_CalAdjustOscillatorVoltage, you must set the action parameter to Commit to write the new calibration constants to the device's EEPROM. If you do not set action to Commit, changes made using external calibration functions will not be applied.

Note Note  
  • If the session is locked, you must unlock the session before calling niSync_CloseExtCal.
  • After invoking niSync_CloseExtCal, you cannot use the the NI-Sync session handle again until you invoke niSync_init or niSync_InitExtCal.
  • If you invoke this function with action set to Commit, the function updates the external calibration date stored in the device's non-volatile onboard memory, even if no calibration constants were changed.

Parameters

Name Type Description
vi ViSession Specifies the instrument handle that you obtain from niSync_init or niSync_InitExtCal.

action ViInt32 Specifies whether or not to write the external calibration constants set using an external calibration function to the device's non-volatile onboard memory.

Valid Values:
NISYNC_VAL_EXT_CAL_ABORT (Default Value)
NISYNC_VAL_EXT_CAL_COMMIT

Return Values