Acquires a mutex for the specified thread.
Note: This routine is not supported in JVM COBOL.
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
or
pic x(8) comp-5 (64-bit native programs only)
|
On Entry:
-
mutex-handle
- Mutex handle
-
nowait-flag
- A 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.
|
- Remaining bits
- Reserved. Must be set to zero.
Comments:
Behavior is undefined if mutex-handle is invalid.