Simple_text_output.enablecursor(), Enablecursor() – Intel Extensible Firmware Interface User Manual

Page 317

Advertising
background image

Protocols

— Console Support

Version 1.10

12/01/02

10-23

SIMPLE_TEXT_OUTPUT.EnableCursor()

Summary

Makes the cursor visible or invisible.

Prototype

EFI_STATUS

(EFIAPI *EFI_TEXT_ENABLE_CURSOR) (

IN

SIMPLE_TEXT_OUTPUT_INTERFACE

*This,

IN

BOOLEAN

Visible

);

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.

Visible

If

TRUE

, the cursor is set to be visible. If

FALSE

, the cursor is set to be

invisible.

Description

The

EnableCursor()

function makes the cursor visible or invisible.

Status Codes Returned

EFI_SUCCESS

The operation completed successfully.

EFI_DEVICE_ERROR

The device had an error and could not complete the request or
the device does not support changing the cursor mode.

EFI_UNSUPPORTED

The output device does not support visibility control of the
cursor.

Advertising