niSync_InitExtCal

C Function Prototype

ViStatus niSync_InitExtCal (ViRsrc resourceName, ViConstString password, ViSession* calibrationInstrumentHandle);

Purpose

Begins an external calibration session for the specified device. The function returns an instrument driver session handle that can be used to adjust calibration constants for the module or read current calibration constants stored in the device's non-volatile memory.

You must close the external calibration session using niSync_CloseExtCal.

Note Note  You must supply the external calibration password for the module for the operation to succeed. Refer to your device's calibration documentation for the default external calibration password.

Parameters

Name Type Description
resourceName ViRsrc Resource name of the module to initialize. The resource name is assigned in Measurement & Automation Explorer (MAX).

Syntax:

PXI[bus number]::device number
NI-DAQmx name


Optional fields are shown in square brackets ([]).


Note  VISA aliases are also valid for the resource name.


Example resource names:
Resource Name Description
Dev1 DAQmx name
PXI1Slot5 DAQmx name
PXI0::15::INSTR PXI bus 0, device number 15
PXI::15::INSTR PXI bus 0, device number 15
PXI4::9::INSTR PXI bus 4, device number 9
password ViConstString Specifies the external calibration password for the module.You must enter the correct case-sensitive password exactly as it is stored in the device's EEPROM to begin an external calibration session.

Note  You can change the external calibration password using niSync_ChangeExtCalPassword.


Default Value: ""

calibrationInstrumentHandle ViSession Returns an instrument handle that you use to identify the instrument in all subsequent instrument driver function calls.

Note  Although you can create more than one NI-Sync session for the same resource, it is best not to do so. A better approach is to use the same NI-Sync session in multiple execution threads. You can use VISA functions viLock and viUnlock to protect sections of code that require exclusive access to the resource.


Return Values