Intel Extensible Firmware Interface - Simple_Text_Output.setmode()

Extensible Firmware Interface Specification
166 12/12/00 Version 1.02
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 ModeNumber
);
Parameters
This A pointer to the SIMPLE_TEXT_OUTPUT_INTERFACE instance.
Type SIMPLE_TEXT_OUTPUT_INTERFACE is defined in Section 7.5.
ModeNumber The text mode to set.
Description
The SetMode() function sets the output device(s) to the requested mode. On success the device
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 The requested text mode was set.
EFI_DEVICE_ERROR The device had an error and could not complete the request.
EFI_UNSUPPORTED The mode number was not valid.