niFgen_CloseExtCal

NI-FGEN C Function

niFgen_CloseExtCal

ViStatus niFgen_CloseExtCal (ViSession vi, ViInt32 action);

Purpose

Closes an NI-FGEN external calibration session and, if specified, stores the new calibration constants and calibration data, such as time and temperature, in the onboard EEPROM.

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.
action ViInt32 Specifies he action to perform upon closing.

Defined Values

NIFGEN_VAL_EXT_CAL_ABORT No changes are made to the calibration constants and data in the EEPROM.
NIFGEN_VAL_EXT_CAL_COMMIT The new calibration constants and data determined during the external calibration session are stored in the onboard EEPROM.

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:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors