VTI Instruments EX1629 - Vtex1629_Lock

VTI Instruments Corp.
200 EX1629 Command Set
vtex1629_lock
FUNCTION PROTOTYPE
ViStatus vtex1629_lock (ViSession vi);
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.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function attempts to acquire a lock on the instrument. When locked, the EX1629 will only accept calls from the
instrument session that successfully acquired the lock. When no client has a lock, calls are accepted from all clients.
A lock can only be acquired if the instrument is not already locked by another user.
By design, the locking mechanism is able to be overridden by a secondary host that issues a vtex1629_break_lock
call. Thus, the lock provides a warning to other users that the unit is in a protected operation state, but not absolute
security.
The lock status of the instrument is unaffected by the vtex1629_reset call. The instrument cannot be reset if the user
is not the owner of the lock.
Self-calibration requires the acquisition of a lock prior to its initiation.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
…
status = vtex1629_lock(instrumentHandle);