Checks whether there is a character waiting to be read from the keyboard.
Restriction: This routine is not currently supported in COBOL for JVM.
Syntax:
call "CBL_GET_KBD_STATUS" using key-status
returning status-code
Parameters:
|
Using call prototype (see
Key)
|
Picture
|
key-status
|
cblt-x1-compx
|
pic x comp-x.
|
status-code
|
See
Library Routines - Key
|
On Exit:
-
key-status
- The status of the keyboard:
0
|
No character available
|
1
|
Character available
|
Comments:
Some UNIX implementations do not allow you to poll the keyboard in this way. See the documentation supplied with your UNIX system to determine if this is the case in your implementation.
This routine should be preceded by an enhanced ACCEPT or DISPLAY statement (see the chapter Adis in your Character User Interfaces) or by calling one of the CBL_ display routines (see the topic Screen Routines). Otherwise, the behavior is undefined. This applies to UNIX environments (remote development) only.
Unpredictable results can occur if the user attempts to use both X"AF" and CBL_ keyboard routines. This is because X"AF" invokes ADIS to perform the required keyboard function and ADIS uses the CBL_ keyboard routines.