Simple_text_output.clearscreen(), Clearscreen(), Func – Intel Extensible Firmware Interface User Manual
Page 315
Protocols
— Console Support
Version 1.10
12/01/02
10-21
SIMPLE_TEXT_OUTPUT.ClearScreen()
Summary
Clears the output device(s) display to the currently selected background color.
Prototype
EFI_STATUS
(EFIAPI *EFI_TEXT_CLEAR_SCREEN) (
IN
SIMPLE_TEXT_OUTPUT_INTERFACE
*This
);
Parameters
This
A pointer to the
instance.
Type
SIMPLE_TEXT_OUTPUT_INTERFACE
is defined in the
“Related Definitions” section of Section 10.3.
Description
The
ClearScreen()
function clears the output device(s) display to the currently selected
background color. The cursor position is set to (0, 0).
Status Codes Returned
EFI_SUCCESS
The operation completed successfully.
EFI_DEVICE_ERROR
The device had an error and could not complete the request.
EFI_UNSUPPORTED
The output device is not in a valid text mode.