niHSDIO_UnlockSession

NI Digital Waveform Generator/Analyzer

niHSDIO_UnlockSession

Specific Function

C Function Prototype

ViStatus niHSDIO_UnlockSession (ViSession vi, ViBoolean* callerHasLock);

Purpose

This function releases a lock that you acquired on an instrument session using niHSDIO_LockSession.

Parameters

Name Type Description
vi ViSession This handle identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function.
callerHasLock ViBoolean 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 niHSDIO_LockSession or niHSDIO_UnlockSession in the same function.

Return Value