Simple_text_output.setcursorposition(), Setcursorposition(), Func – Intel Extensible Firmware Interface User Manual

Page 316

Advertising
background image

Extensible Firmware Interface Specification

10-22

12/01/02

Version 1.10

SIMPLE_TEXT_OUTPUT.SetCursorPosition()

Summary

Sets the current coordinates of the cursor position.

Prototype

EFI_STATUS

(EFIAPI *EFI_TEXT_SET_CURSOR_POSITION) (

IN

SIMPLE_TEXT_OUTPUT_INTERFACE

*This,

IN

UINTN

Column,

IN

UINTN

Row

);

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.

Column, Row

The position to set the cursor to. Must greater than or equal to zero and
less than the number of columns and rows returned by

QueryMode()

.

Description

The

SetCursorPosition()

function sets the current coordinates of the cursor position. The

upper left corner of the screen is defined as coordinate (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, or the cursor
position is invalid for the current mode.

Advertising