CBL_MUTEX_ACQUIRE

Syntax:

call "CBL_MUTEX_ACQUIRE" using by value mutex-handle
                               by value nowait-flag

Parameters:

  Using call prototype (see Key) Picture
mutex-handle cblt-pointer. usage pointer.
nowait-flag cblt-os-flags. pic x(4) comp-5.

On Entry:

mutex-handle
Mutex handle
nowait-flag
A 32-bit number that determines what happens if the mutex cannot be acquired immediately:
Bit 0
0 The routine blocks the thread/process until the mutex can be acquired .
1 The routine returns immediately with a non-zero return value.
Bits 1-31
Reserved. Must be set to zero.

On Exit:

return-code
A value of 0 indicates that the call was successful. Any other value indicates an error. See RETURN-CODE Values For Synchronization Routines.

Comments:

Behavior is undefined if mutex-handle is invalid.