Simple_Input.readkeystroke - Intel Extensible Firmware Interface Specification

Extensible Firmware Interface Specification
7.3.2

SIMPLE_INPUT.ReadKeyStroke

Summary
Reads the next keystroke from the input device.
Prototype
EFI_STATUS
(EFIAPI *EFI_INPUT_READ_KEY) (
IN SIMPLE_INPUT_INTERFACE
OUT EFI_INPUT_KEY
);
Parameters
This
Key
Related Definitions
//*******************************************************
// EFI_INPUT_KEY
//*******************************************************
typedef struct {
UINT16
CHAR16
} EFI_INPUT_KEY;
Description
The
ReadKeyStroke()
pending keystroke the function returns EFI_NOT_READY. If there is a pending keystroke, then
is the EFI scan code defined in Table 7-2. The
ScanCode
character or is zero if the key does not represent a printable character (control key, function
key, etc.).
Status Codes Returned
EFI_SUCCESS
EFI_NOT_READY
EFI_DEVICE_ERROR
156
*This,
*Key
A pointer to the
SIMPLE_INPUT_INTERFACE
SIMPLE_INPUT_INTERFACE
A pointer to a buffer that is filled in with the keystroke
information for the key that was pressed. Type
EFI_INPUT_KEY
ScanCode;
UnicodeChar;
function reads the next keystroke from the input device. If there is no
The keystroke information was returned.
There was no keystroke data available.
The keystroke information was not returned due to hardware errors.
12/12/00
is defined in Section 7.3.
is defined in "Related Definitions".
is the actual printable
UnicodeChar
Version 1.02
instance. Type