ClassPrefix_UnlockSession
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_UnlockSession.
C Function Prototype
ViStatus ClassPrefix_UnlockSession (ViSession vi, ViBoolean *callerHasLock);
Purpose
This function releases a lock that you acquired on an instrument session using ClassPrefix_LockSession.
Parameters
| Inputs | 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. |
| Outputs | Type | Description |
| callerHasLock | ViBoolean | This parameter serves as a convenience. If you do not want to use this parameter, pass VI_NULL. Use this parameter in complex functions to keep track of whether you obtain a lock and therefore need to unlock the session. Pass the address of a local ViBoolean variable. In the declaration of the local variable, initialize it to VI_FALSE. Pass the address of the same local variable to any other calls you make to ClassPrefix_LockSession or ClassPrefix_UnlockSession in the same function. |