ConsoleWrappers.h File Reference

Go to the source code of this file.

Functions
EFI_SIMPLE_TEXT_INPUT_PROTOCOL *	CreateSimpleTextInOnFile (IN SHELL_FILE_HANDLE FileHandleToUse, IN EFI_HANDLE *HandleLocation)
EFI_STATUS	CloseSimpleTextInOnFile (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *SimpleTextIn)
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	CreateSimpleTextOutOnFile (IN SHELL_FILE_HANDLE FileHandleToUse, IN EFI_HANDLE *HandleLocation, IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *OriginalProtocol)
EFI_STATUS	CloseSimpleTextOutOnFile (IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *SimpleTextOut)

Detailed Description

Function definitions for shell simple text in and out on top of file handles.

(C) Copyright 2013 Hewlett-Packard Development Company, L.P.
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ConsoleWrappers.h.

Function Documentation

CloseSimpleTextInOnFile()

EFI_STATUS CloseSimpleTextInOnFile

(

IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *

SimpleTextIn

)

Function to close a EFI_SIMPLE_TEXT_INPUT_PROTOCOL on top of a SHELL_FILE_HANDLE to support redirecting input from a file.

Parameters

[in]

SimpleTextIn

The pointer to the SimpleTextIn to close.

Return values

EFI_SUCCESS

The object was closed.

Definition at line 202 of file ConsoleWrappers.c.

CloseSimpleTextOutOnFile()

EFI_STATUS CloseSimpleTextOutOnFile

(

IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *

SimpleTextOut

)

Function to close a EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL on top of a SHELL_FILE_HANDLE to support redirecting output from a file.

Parameters

[in]

SimpleTextOut

The pointer to the SimpleTextOUT to close.

Return values

EFI_SUCCESS

The object was closed.

Definition at line 506 of file ConsoleWrappers.c.

CreateSimpleTextInOnFile()

EFI_SIMPLE_TEXT_INPUT_PROTOCOL * CreateSimpleTextInOnFile	(	IN SHELL_FILE_HANDLE	FileHandleToUse,
		IN EFI_HANDLE *	HandleLocation
	)

Function to create a EFI_SIMPLE_TEXT_INPUT_PROTOCOL on top of a SHELL_FILE_HANDLE to support redirecting input from a file.

Parameters

[in]	FileHandleToUse	The pointer to the SHELL_FILE_HANDLE to use.
[in]	HandleLocation	The pointer of a location to copy handle with protocol to.

Return values

NULL	There was insufficient memory available.

Returns

A pointer to the allocated protocol structure;

Todo:

possibly also install SimpleTextInputEx on the handle at this point.

Definition at line 134 of file ConsoleWrappers.c.

CreateSimpleTextOutOnFile()

EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * CreateSimpleTextOutOnFile	(	IN SHELL_FILE_HANDLE	FileHandleToUse,
		IN EFI_HANDLE *	HandleLocation,
		IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	OriginalProtocol
	)

Function to create a EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL on top of a SHELL_FILE_HANDLE to support redirecting output from a file.

Parameters

[in]	FileHandleToUse	The pointer to the SHELL_FILE_HANDLE to use.
[in]	HandleLocation	The pointer of a location to copy handle with protocol to.
[in]	OriginalProtocol	The pointer to the original output protocol for pass thru of functions.

Return values

NULL	There was insufficient memory available.

Returns

A pointer to the allocated protocol structure;

Definition at line 439 of file ConsoleWrappers.c.