projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 8be0ba36 | 1 | /** @file\r |
| 2 | Function definitions for shell simple text in and out on top of file handles.\r | |
| 3 | \r | |
| c011b6c9 | 4 | (C) Copyright 2013 Hewlett-Packard Development Company, L.P.<BR>\r |
| ba0014b9 | 5 | Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| 56ba3746 | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 8be0ba36 | 7 | \r |
| 8 | **/\r | |
| 9 | \r | |
| 10 | #ifndef _SHELL_CONSOLE_WRAPPERS_HEADER_\r | |
| 11 | #define _SHELL_CONSOLE_WRAPPERS_HEADER_\r | |
| 12 | \r | |
| 13 | /**\r | |
| ba0014b9 | 14 | Function to create a EFI_SIMPLE_TEXT_INPUT_PROTOCOL on top of a\r |
| 8be0ba36 | 15 | SHELL_FILE_HANDLE to support redirecting input from a file.\r |
| 16 | \r | |
| 17 | @param[in] FileHandleToUse The pointer to the SHELL_FILE_HANDLE to use.\r | |
| 18 | @param[in] HandleLocation The pointer of a location to copy handle with protocol to.\r | |
| 19 | \r | |
| 20 | @retval NULL There was insufficient memory available.\r | |
| 21 | @return A pointer to the allocated protocol structure;\r | |
| 22 | **/\r | |
| 47d20b54 MK |
23 | EFI_SIMPLE_TEXT_INPUT_PROTOCOL *\r |
| 24 | CreateSimpleTextInOnFile (\r | |
| 8be0ba36 | 25 | IN SHELL_FILE_HANDLE FileHandleToUse,\r |
| 26 | IN EFI_HANDLE *HandleLocation\r | |
| 27 | );\r | |
| 28 | \r | |
| 29 | /**\r | |
| ba0014b9 | 30 | Function to close a EFI_SIMPLE_TEXT_INPUT_PROTOCOL on top of a\r |
| 8be0ba36 | 31 | SHELL_FILE_HANDLE to support redirecting input from a file.\r |
| 32 | \r | |
| 33 | @param[in] SimpleTextIn The pointer to the SimpleTextIn to close.\r | |
| 34 | \r | |
| 35 | @retval EFI_SUCCESS The object was closed.\r | |
| 36 | **/\r | |
| 37 | EFI_STATUS\r | |
| 47d20b54 | 38 | CloseSimpleTextInOnFile (\r |
| 8be0ba36 | 39 | IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *SimpleTextIn\r |
| 40 | );\r | |
| 41 | \r | |
| 42 | /**\r | |
| ba0014b9 | 43 | Function to create a EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL on top of a\r |
| 8be0ba36 | 44 | SHELL_FILE_HANDLE to support redirecting output from a file.\r |
| 45 | \r | |
| dcf9b428 CP |
46 | @param[in] FileHandleToUse The pointer to the SHELL_FILE_HANDLE to use.\r |
| 47 | @param[in] HandleLocation The pointer of a location to copy handle with protocol to.\r | |
| 48 | @param[in] OriginalProtocol The pointer to the original output protocol for pass thru of functions.\r | |
| 8be0ba36 | 49 | \r |
| 50 | @retval NULL There was insufficient memory available.\r | |
| 51 | @return A pointer to the allocated protocol structure;\r | |
| 52 | **/\r | |
| 47d20b54 MK |
53 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *\r |
| 54 | CreateSimpleTextOutOnFile (\r | |
| 55 | IN SHELL_FILE_HANDLE FileHandleToUse,\r | |
| 56 | IN EFI_HANDLE *HandleLocation,\r | |
| 57 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *OriginalProtocol\r | |
| 8be0ba36 | 58 | );\r |
| 59 | \r | |
| 60 | /**\r | |
| ba0014b9 | 61 | Function to close a EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL on top of a\r |
| 8be0ba36 | 62 | SHELL_FILE_HANDLE to support redirecting output from a file.\r |
| 63 | \r | |
| 733f138d | 64 | @param[in] SimpleTextOut The pointer to the SimpleTextOUT to close.\r |
| 8be0ba36 | 65 | \r |
| 66 | @retval EFI_SUCCESS The object was closed.\r | |
| 67 | **/\r | |
| 68 | EFI_STATUS\r | |
| 47d20b54 | 69 | CloseSimpleTextOutOnFile (\r |
| 733f138d | 70 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *SimpleTextOut\r |
| 8be0ba36 | 71 | );\r |
| 72 | \r | |
| 73 | #endif //_SHELL_CONSOLE_WRAPPERS_HEADER_\r |