ClassPrefix_close

CVI/LabWindows IVI Class Driver

ClassPrefix_close

IVI Inherent Function

To form the ClassPrefix_ of the function name, use the prefix of the class driver with which you are working. For example, if you are working with the IviDmm class driver, use the prefix IviDmm_ to create the correct function name, IviDmm_close.

C Function Prototype

ViStatus ClassPrefix_close (ViSession vi);

Purpose

When you are finished using an instrument driver session, you must call the ClassPrefix_close. ClassPrefix_close performs the following actions.

  • Closes the instrument I/O session.
  • Destroys the IVI session and all of its attributes.
  • Deallocates any memory resources used by the IVI session.

You might also want to put the instrument into an Idle state before closing the I/O session. For example, a switch driver might disconnect all switches.

Parameter

Name Type Description
vi ViSession The instrument handle that you obtain from the ClassPrefix_init or ClassPrefix_InitWithOptions functions. The handle identifies a particular IVI session.

Return Values