RFSA C Reference

niRFSA_CloseExternalAlignment

  • Updated2025-02-03
  • 1 minute(s) read

niRFSA_CloseExternalAlignment

ViStatus niRFSA_CloseExternalAlignment(ViSession vi, ViInt32 action);

Purpose

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

Supported Devices: PXIe-5605 (PXIe-5665 only), PXIe-5606 (PXIe-5668 only)

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_InitializeExternalAlignment function and identifies a particular instrument session.
action ViInt32 Specifies how to use the alignment values from this session as the session is closed.

NIRFSA_VAL_EXT_CAL_ABORT The old alignment constants are kept, and the new ones are discarded.
NIRFSA_VAL_EXT_CAL_COMMITThe new alignment constants are stored in the 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. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience