Simple_Text_Output.setmode() - Intel Extensible Firmware Interface Specification

Extensible Firmware Interface Specification
7.5.5

SIMPLE_TEXT_OUTPUT.SetMode()

Summary
Sets the output device(s) to a specified mode.
Prototype
EFI_STATUS
(* EFIAPI EFI_TEXT_SET_MODE) (
IN SIMPLE_TEXT_OUTPUT_INTERFACE *This,
IN UINTN
);
Parameters
This
ModeNumber
Description
The function sets the output device(s) to the requested mode. On success the device
SetMode()
is in the geometry for the requested mode, and the device has been cleared to the current
background color with the cursor at (0,0).
Status Codes Returned
EFI_SUCCESS
EFI_DEVICE_ERROR
EFI_UNSUPPORTED
166
A pointer to the
SIMPLE_TEXT_OUTPUT_INTERFACE
Type
SIMPLE_TEXT_OUTPUT_INTERFACE
The text mode to set.
The requested text mode was set.
The device had an error and could not complete the request.
The mode number was not valid.
12/12/00
ModeNumber
is defined in Section 7.5.
Version 1.02
instance.