Reads user input.
#include <diag/diago.h> long diag_asl_read ( screen_code, wait, buf ) ASL_SCREEN_CODE screen_code; int wait; char *buf;
The diag_asl_read subroutine reads the keyboard buffer.
| Parameter | Description |
|---|---|
| screen_code | Identifies the set of function keys that should be active. |
| wait | If True, causes this subroutine to wait until the user presses one of the keys allowed by the screen_type. If this parameter is False, then this subroutine does not wait for the user input but processes anything typed ahead just as it would if the parameter were True. |
| buf | Allocated by the application. It is used to return the values entered by the user. If used, this buffer MUST be at least ASL_READ_BUF_SIZE. Normally this value should be set to NULL. When NULL, only the function key pressed is returned. |
The diag_asl_read subroutine returns one of the following values:
| Return Value | Description |
|---|---|
| DIAG_ASL_OK | Successful return. |
| DIAG_ASL_FAIL | Failure reading data. |
| DIAG_ASL_CANCEL | Cancel key was entered. |
| DIAG_ASL_ENTER | Enter key was entered. |
| DIAG_ASL_EXIT | Exit key was entered. |