ShellPkg/UefiShellDebug1CommandsLib: Remove unnecessary EFIAPI
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / EditInputBar.h
1 /** @file
2 Declares imputbar interface functions.
3
4 Copyright (c) 2005 - 2011, 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
9
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.
12
13 **/
14
15 #ifndef _LIB_INPUT_BAR_H_
16 #define _LIB_INPUT_BAR_H_
17
18 /**
19 Initialize the input bar.
20 **/
21 VOID
22 InputBarInit (
23 VOID
24 );
25
26 /**
27 Cleanup function for input bar.
28 **/
29 VOID
30 InputBarCleanup (
31 VOID
32 );
33
34 /**
35 The refresh function for InputBar, it will wait for user input
36
37 @param[in] LastRow The last printable row.
38 @param[in] LastColumn The last printable column.
39
40 @retval EFI_SUCCESS The operation was successful.
41 **/
42 EFI_STATUS
43 InputBarRefresh (
44 UINTN LastRow,
45 UINTN LastColumn
46 );
47
48 /**
49 SetPrompt and wait for input.
50
51 @param[in] Str The prompt string.
52
53 @retval EFI_SUCCESS The operation was successful.
54 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
55 **/
56 EFI_STATUS
57 InputBarSetPrompt (
58 IN CONST CHAR16 *Str
59 );
60
61 /**
62 Set the size of the string in characters.
63
64 @param[in] Size The max number of characters to accept.
65
66 @retval EFI_SUCCESS The operation was successful.
67 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
68 **/
69 EFI_STATUS
70 InputBarSetStringSize (
71 UINTN Size
72 );
73
74 /**
75 Function to retrieve the input from the user.
76
77 @retval NULL No input has been received.
78 @return The string that was input.
79 **/
80 CONST CHAR16*
81 InputBarGetString (
82 VOID
83 );
84
85 #endif