Intel Extensible Firmware Interface - Simple_Text_Output.enablecursor()

Console I/O Protocol
Version 1.02 12/12/00 171
7.5.9 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 Section 7.5.
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 is not in a valid text mode, or the cursor
position is invalid for the current mode.