VTI Instruments EX1629 - Vtex1629_Check_Lock

VTI Instruments Corp.
108 EX1629 Command Set
vtex1629_check_lock
FUNCTION PROTOTYPE
ViStatus vtex1629_check_lock (ViSession vi, ViPBoolean locked, ViPBoolean mine);
FUNCTION PARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
locked = a Boolean return value indicating if the EX1629 is locked. A return value of “1” indicates that the EX1629
is locked.
mine = a Boolean return value indicating if the session that called the vtex1629_check_lock function owns the lock.
A value of “1” returned indicates that the EX1629 is locked and that the current session owns that lock.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function checks the lock status of the EX1629 instrument. It reports whether it is locked and if so whether the
current session owns the lock. When locked, the EX1629 will only accept function calls from the session handle that
issued the lock function call. When not locked, the EX1629 will accept function calls from any client.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViBoolean locked, mine;
…
status = vtex1629_check_lock (instrumentHandle, &locked, &mine);
if( locked == VI_TRUE && mine == VI_TRUE ){
printf(“Instrument locked by this client!\n”);
}