Intel Extensible Firmware Interface - Manual (Page 311)

Protocols — Console Support
Version 1.10 12/01/02 10-17
SIMPLE_TEXT_OUTPUT.QueryMode()
Summary
Returns information for an available text mode that the output device(s) supports.
Prototype
EFI_STATUS
(EFIAPI *EFI_TEXT_QUERY_MODE) (
IN SIMPLE_TEXT_OUTPUT_INTERFACE *This,
IN UINTN ModeNumber,
OUT UINTN *Columns,
OUT UINTN *Rows
);
Parameters
This A pointer to the SIMPLE_TEXT_OUTPUT_INTERFACE instance.
Type SIMPLE_TEXT_OUTPUT_INTERFACE is defined in the
“Related Definitions” section of Section 10.3.
ModeNumber The mode number to return information on.
Columns, Rows Returns the geometry of the text output device for the request
ModeNumber .
Description
The QueryMode() function returns information for an available text mode that the output
device(s) supports.
It is required that all output devices support at least 80x25 text mode. This mode is defined to be
mode 0. If the output devices support 80x50, that is defined to be mode 1. Any other text
dimensions supported by the device may then follow as mode 2 and above. (For example, it is a
prerequisite that 80x25 and 80x50 text modes be supported before any other modes are.)
Status Codes Returned
EFI_SUCCESS The requested mode information was returned.
EFI_DEVICE_ERROR The device had an error and could not complete the request.
EFI_UNSUPPORTED The mode number was not valid.