/ docs / man / man3 / hal_set_lock.3hal
hal_set_lock.3hal
 1  .TH hal_set_lock "3hal" "2006-10-12" "LinuxCNC Documentation" "HAL"
 2  .SH NAME
 3  
 4  hal_set_lock, hal_get_lock \- Set or get the HAL lock level
 5  
 6  .SH SYNTAX
 7  .HP
 8  int hal_set_lock(unsigned char \fIlock_type\fR)
 9  
10  .HP
11  int hal_get_lock()
12  
13  .SH  ARGUMENTS
14  .IP \fIlock_type\fR
15  The desired lock type, which may be a bitwise combination of: \fBHAL_LOCK_LOAD\fR, \fBHAL_LOCK_CONFIG\fR, \fBHAL_LOCK_PARAMS\fR, or \fBHAL_LOCK_PARAMS\fR.  \fBHAL_LOCK_NONE\fR or 0 locks nothing, and \fBHAL_LOCK_ALL\fB locks everything.
16  
17  .SH DESCRIPTION
18  
19  .SH RETURN VALUE
20  \fBhal_set_lock\fR Returns a HAL status code.  \fBhal_get_lock\fR returns the
21  current HAL lock level or a HAL status code.