NI-Digital Pattern Driver C Function Reference

niDigital_UnlockSession

  • Updated2023-11-24
  • 1 minute(s) read

niDigital_UnlockSession

Session Locking Group

Releases a lock that you acquired on an instrument session using the niDigital_LockSession function.

C Function Prototype: ViStatus niDigital_UnlockSession (ViSession vi, ViBoolean* callerHasLock)

Parameter Description
vi The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
callerHasLock This parameter serves as a convenience. If you do not want to use this parameter, pass VI_NULL. You can use this parameter in complex functions to track lock status and the need to unlock the session. Pass the address of a local ViBoolean variable in the declaration of the local variable and initialize it to VI_FALSE. Also, pass the address of the same local variable to any other calls you make to niDigital_LockSession or niDigital_UnlockSession in the same function.

Return value: Reports the status of the operation.