Comment's added and fixed.

[mirror_edk2.git] / ShellPkg / Application / Shell / ConsoleWrappers.h

/** @file\r
  Function definitions for shell simple text in and out on top of file handles.\r
\r
  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _SHELL_CONSOLE_WRAPPERS_HEADER_\r
#define _SHELL_CONSOLE_WRAPPERS_HEADER_\r
\r
/**\r
  Function to create a EFI_SIMPLE_TEXT_INPUT_PROTOCOL on top of a \r
  SHELL_FILE_HANDLE to support redirecting input from a file.\r
\r
  @param[in]  FileHandleToUse The pointer to the SHELL_FILE_HANDLE to use.\r
  @param[in]  HandleLocation  The pointer of a location to copy handle with protocol to.\r
\r
  @retval NULL                There was insufficient memory available.\r
  @return                     A pointer to the allocated protocol structure;\r
**/\r
EFI_SIMPLE_TEXT_INPUT_PROTOCOL*\r
EFIAPI\r
CreateSimpleTextInOnFile(\r
  IN SHELL_FILE_HANDLE  FileHandleToUse,\r
  IN EFI_HANDLE         *HandleLocation\r
  );\r
\r
/**\r
  Function to close a EFI_SIMPLE_TEXT_INPUT_PROTOCOL on top of a \r
  SHELL_FILE_HANDLE to support redirecting input from a file.\r
\r
  @param[in]  SimpleTextIn    The pointer to the SimpleTextIn to close.\r
\r
  @retval EFI_SUCCESS         The object was closed.\r
**/\r
EFI_STATUS\r
EFIAPI\r
CloseSimpleTextInOnFile(\r
  IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *SimpleTextIn\r
  );\r
\r
/**\r
  Function to create a EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL on top of a \r
  SHELL_FILE_HANDLE to support redirecting output from a file.\r
\r
  @param[in]  FileHandleToUse The pointer to the SHELL_FILE_HANDLE to use.\r
  @param[in]  HandleLocation  The pointer of a location to copy handle with protocol to.\r
\r
  @retval NULL                There was insufficient memory available.\r
  @return                     A pointer to the allocated protocol structure;\r
**/\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL*\r
EFIAPI\r
CreateSimpleTextOutOnFile(\r
  IN SHELL_FILE_HANDLE  FileHandleToUse,\r
  IN EFI_HANDLE         *HandleLocation\r
  );\r
\r
/**\r
  Function to close a EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL on top of a \r
  SHELL_FILE_HANDLE to support redirecting output from a file.\r
\r
  @param[in] SimpleTextOut    The pointer to the SimpleTextOUT to close.\r
\r
  @retval EFI_SUCCESS         The object was closed.\r
**/\r
EFI_STATUS\r
EFIAPI\r
CloseSimpleTextOutOnFile(\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *SimpleTextOut\r
  );\r
\r
#endif //_SHELL_CONSOLE_WRAPPERS_HEADER_\r
\r