EditInputBar.h File Reference

Go to the source code of this file.

Functions
VOID	InputBarInit (IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *TextInEx)
VOID	InputBarCleanup (VOID)
EFI_STATUS	InputBarRefresh (UINTN LastRow, UINTN LastColumn)
EFI_STATUS	InputBarSetPrompt (IN CONST CHAR16 *Str)
EFI_STATUS	InputBarSetStringSize (UINTN Size)
CONST CHAR16 *	InputBarGetString (VOID)

Detailed Description

Declares imputbar interface functions.

Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file EditInputBar.h.

Function Documentation

InputBarCleanup()

VOID InputBarCleanup

(

VOID

)

Cleanup function for input bar.

Definition at line 37 of file EditInputBar.c.

InputBarGetString()

CONST CHAR16 * InputBarGetString

(

VOID

)

Function to retrieve the input from the user.

Return values

NULL	No input has been received.

Returns

The string that was input.

Definition at line 318 of file EditInputBar.c.

InputBarInit()

VOID InputBarInit

(

IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *

TextInEx

)

Initialize the input bar.

Parameters

[in]

TextInEx

Pointer to SimpleTextInEx instance in System Table.

Definition at line 23 of file EditInputBar.c.

InputBarRefresh()

EFI_STATUS InputBarRefresh	(	UINTN	LastRow,
		UINTN	LastColumn
	)

The refresh function for InputBar, it will wait for user input

Parameters

[in]	LastRow	The last printable row.
[in]	LastColumn	The last printable column.

Return values

EFI_SUCCESS

The operation was successful.

Definition at line 118 of file EditInputBar.c.

InputBarSetPrompt()

EFI_STATUS InputBarSetPrompt

(

IN CONST CHAR16 *

Str

)

SetPrompt and wait for input.

Parameters

[in]

Str

The prompt string.

Return values

EFI_SUCCESS	The operation was successful.
EFI_OUT_OF_RESOURCES	A memory allocation failed.

Definition at line 267 of file EditInputBar.c.

InputBarSetStringSize()

EFI_STATUS InputBarSetStringSize

(

UINTN

Size

)

Set the size of the string in characters.

Parameters

[in]

Size

The max number of characters to accept.

Return values

EFI_SUCCESS	The operation was successful.
EFI_OUT_OF_RESOURCES	A memory allocation failed.

Definition at line 293 of file EditInputBar.c.