Required IVI Functions Overview

IVI Library

This topic contains information and function descriptions for instrument driver functions that each IVI instrument driver must implement. A related LabWindows/CVI Instrument Driver Developers Guide exists to help you develop and use instrument drivers. To download and use this document, click ni.com/manuals, and search for the LabWindows/CVI Instrument Driver Developers Guide.

The required functions are grouped into the following three categories. To access information about each function, you can use the following list of required functions or click on Alphabetical List of Required IVI Functions section of the Contents tab.

Initialize/Close Functions

Utility Functions

Wrappers for IVI engine Functions

  • Prefix _GetError
  • Prefix _ClearError
  • Prefix _LockSession
  • Prefix _UnlockSession
  • Prefix _ReadInstrData
  • Prefix _WriteInstrData
  • Prefix _GetNextInterchangeWarning
  • Prefix _ClearInterchangeWarnings
  • Prefix _ResetInterchangeCheck
  • Prefix _InvalidateAllAttributes
  • Prefix _GetNextCoercionRecord

Except for Prefix _IviInit and Prefix_IviClose, all the required functions are user-callable. The instrument driver must have function panels for the user-callable functions and must have function prototypes for them in the include file. No function panels or prototypes are necessary for the Prefix_IviInit and Prefix_IviClose functions.

The Prefix_init function and the Prefix_InitWithOptions function call Prefix_IviInit. The Prefix_close function calls Prefix_IviClose. In a specific instrument driver, the Prefix_IviInit and Prefix_IviClose functions contain the bulk of the code that performs the initialization and closing operations for the particular instrument.

This section contains descriptions for the Initialize/Close functions and the Utility functions, including the implementation requirements. For the Wrapper functions, refer to the corresponding functions in the IVI engine Overview.

Note    If you use the instrument driver developer wizard to create your instrument driver, the source file that the wizard generates contains the required functions with as much of the implementation source code as possible and with comments explaining how to complete the functions.