User manual

2. Device Driver Function Reference
All function calls require the argument instrumentID in order to identify the Acqiris Instrument to which the call is
directed. The only exceptions are the initialization/termination functions:
•
Acqrs_calibrate
• Acqrs_calibrateEx • Acqrs_close
• Acqrs_closeAll • Acqrs_getNbrInstruments • Acqrs_init
•
Acqrs_InitWithOptions • Acqrs_setSimulationOptions
• AcqrsD1_close • AcqrsD1_init • AcqrsD1_InitWithOptions
•
AcqrsD1_getNbrPhysicalInstruments • AcqrsD1_multiInstrAutoDefine
•
AcqrsD1_setSimulationOptions • AcqrsD1_multiInstrUndefineAll
The functions
Acqrs_init, Acqrs_InitWithOptions, AcqrsD1_init, AcqrsD1_InitWithOptions, and
AcqrsD1_multiInstrDefine actually return instrument identifiers at initialization time, for subsequent use in the
other function calls.
2.1. Status values and Error codes
All function calls return a status value of type 'ViStatus' with information about the success or failure of the call. All
Acqiris specific values can be found in the header file AcqirisErrorCodes.h and are shown in
Table 2-1. The
generic ones, defined by the VXIplug&play Systems Alliance, are listed in the header file vpptype.h (VXIplug&play
instrument driver header file, which includes visatype.h: fundamental VISA data types and macro definitions). They
are reproduced in
Table 2-2 for convenience. The header file AcqirisD1Interface.h shows the common error codes
associated with each function.
Acqiris Error Codes Hex value Decimal value
ACQIRIS_ERROR_FILE_NOT_FOUND
BFFA4800 -1074116608
ACQIRIS_ERROR_PATH_NOT_FOUND
BFFA4801 -1074116607
ACQIRIS_ERROR_INVALID_HANDLE
BFFA4803 -1074116605
ACQIRIS_ERROR_NOT_SUPPORTED
BFFA4805 -1074116603
ACQIRIS_ERROR_INVALID_WINDOWS_PARAM
BFFA4806 -1074116602
ACQIRIS_ERROR_NO_DATA
BFFA4807 -1074116601
ACQIRIS_ERROR_NO_ACCESS
BFFA4808 -1074116600
ACQIRIS_ERROR_BUFFER_OVERFLOW
BFFA4809 -1074116599
ACQIRIS_ERROR_BUFFER_NOT_64BITS_ALIGNED
BFFA480A -1074116598
ACQIRIS_ERROR_BUFFER_NOT_32BITS_ALIGNED
BFFA480B -1074116597
ACQIRIS_ERROR_ALREADY_OPEN
BFFA4840 -1074116544
ACQIRIS_ERROR_SETUP_NOT_AVAILABLE
BFFA4880 -1074116480
ACQIRIS_ERROR_IO_WRITE
BFFA48A0 -1074116448
ACQIRIS_ERROR_IO_READ
BFFA48A1 -1074116447
ACQIRIS_ERROR_IO_DEVICE_OFF
BFFA48A2 -1074116446
ACQIRIS_ERROR_INTERNAL_DEVICENO_INVALID
BFFA48C0 -1074116416
ACQIRIS_ERROR_TOO_MANY_DEVICES
BFFA48C1 -1074116415
ACQIRIS_ERROR_EEPROM_DATA_INVALID
BFFA48C2 -1074116414
ACQIRIS_ERROR_INIT_STRING_INVALID
BFFA48C3 -1074116413
ACQIRIS_ERROR_INSTRUMENT_NOT_FOUND
BFFA48C4 -1074116412
ACQIRIS_ERROR_INSTRUMENT_RUNNING
BFFA48C5 -1074116411
ACQIRIS_ERROR_INSTRUMENT_STOPPED
BFFA48C6 -1074116410
ACQIRIS_ERROR_MODULES_NOT_ON_SAME_BUS
BFFA48C7 -1074116409
ACQIRIS_ERROR_NOT_ENOUGH_DEVICES
BFFA48C8 -1074116408
ACQIRIS_ERROR_NO_MASTER_DEVICE
BFFA48C9 -1074116407
ACQIRIS_ERROR_PARAM_STRING_INVALID
BFFA48CA -1074116406
ACQIRIS_ERROR_COULD_NOT_CALIBRATE
BFFA48CB -1074116405
ACQIRIS_ERROR_CANNOT_READ_THIS_CHANNEL
BFFA48CC -1074116404
ACQIRIS_ERROR_PRETRIGGER_STILL_RUNNING
BFFA48CD -1074116403
ACQIRIS_ERROR_CALIBRATION_FAILED
BFFA48CE -1074116402
ACQIRIS_ERROR_MODULES_NOT_CONTIGUOUS
BFFA48CF -1074116401
ACQIRIS_ERROR_INSTRUMENT_ACQ_LOCKED
BFFA48D0 -1074116400
ACQIRIS_ERROR_INSTRUMENT_ACQ_NOT_LOCKED
BFFA48D1 -1074116399
ACQIRIS_ERROR_EEPROM2_DATA_INVALID
BFFA48D2 -1074116398
ACQIRIS_ERROR_INVALID_GEOMAP_FILE
BFFA48E0 -1074116384
ACQIRIS_ERROR_ACQ_TIMEOUT
BFFA4900 -1074116352
ACQIRIS_ERROR_OVERLOAD
BFFA4901 -1074116351
ACQIRIS_ERROR_PROC_TIMEOUT
BFFA4902 -1074116350
ACQIRIS_ERROR_LOAD_TIMEOUT
BFFA4903 -1074116349
Programmer’s Reference Manual Page 8 of 210