2 Declares imputbar interface functions.
4 Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _LIB_INPUT_BAR_H_
16 #define _LIB_INPUT_BAR_H_
19 Initialize the input bar.
21 @param[in] TextInEx Pointer to SimpleTextInEx instance in System Table.
25 IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*TextInEx
29 Cleanup function for input bar.
37 The refresh function for InputBar, it will wait for user input
39 @param[in] LastRow The last printable row.
40 @param[in] LastColumn The last printable column.
42 @retval EFI_SUCCESS The operation was successful.
51 SetPrompt and wait for input.
53 @param[in] Str The prompt string.
55 @retval EFI_SUCCESS The operation was successful.
56 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
64 Set the size of the string in characters.
66 @param[in] Size The max number of characters to accept.
68 @retval EFI_SUCCESS The operation was successful.
69 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
72 InputBarSetStringSize (
77 Function to retrieve the input from the user.
79 @retval NULL No input has been received.
80 @return The string that was input.