ShellPkg/Application: Fix various typos

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

/** @file\r
  EFI_FILE_PROTOCOL wrappers for other items (Like Environment Variables, StdIn, StdOut, StdErr, etc...)\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _SHELL_FILE_HANDLE_WRAPPERS_HEADER_\r
#define _SHELL_FILE_HANDLE_WRAPPERS_HEADER_\r
\r
typedef struct {\r
  LIST_ENTRY        Link;\r
  CHAR16*           Buffer;\r
} SHELL_LINE_LIST;\r
\r
typedef struct {\r
  UINTN             LogCount;\r
  SHELL_LINE_LIST   *Log;\r
} SHELL_LINE_LOG;\r
\r
///\r
/// FILE styte interfaces for StdIn.\r
///\r
extern EFI_FILE_PROTOCOL FileInterfaceStdIn;\r
\r
///\r
/// FILE styte interfaces for StdOut.\r
///\r
extern EFI_FILE_PROTOCOL FileInterfaceStdOut;\r
\r
///\r
/// FILE styte interfaces for StdErr.\r
///\r
extern EFI_FILE_PROTOCOL FileInterfaceStdErr;\r
\r
///\r
/// FILE style interface for NUL file.\r
///\r
extern EFI_FILE_PROTOCOL FileInterfaceNulFile;\r
\r
/**\r
  Creates a EFI_FILE_PROTOCOL (almost) object for using to access\r
  environment variables through file operations.\r
\r
  @param EnvName    The name of the Environment Variable to be operated on.\r
\r
  @retval NULL      Memory could not be allocated.\r
  @return other     a pointer to an EFI_FILE_PROTOCOL structure\r
**/\r
EFI_FILE_PROTOCOL*\r
CreateFileInterfaceEnv(\r
  CONST CHAR16 *EnvName\r
  );\r
\r
/**\r
  Creates a EFI_FILE_PROTOCOL (almost) object for using to access\r
  a file entirely in memory through file operations.\r
\r
  @param[in] Unicode  TRUE if the data is UNICODE, FALSE otherwise.\r
\r
  @retval NULL      Memory could not be allocated.\r
  @return other     a pointer to an EFI_FILE_PROTOCOL structure\r
**/\r
EFI_FILE_PROTOCOL*\r
CreateFileInterfaceMem(\r
  IN CONST BOOLEAN Unicode\r
  );\r
\r
/**\r
  Creates a EFI_FILE_PROTOCOL (almost) object for using to access\r
  a file entirely with unicode awareness through file operations.\r
\r
  @param[in] Template The pointer to the handle to start with.\r
  @param[in] Unicode  TRUE if the data is UNICODE, FALSE otherwise.\r
\r
  @retval NULL      Memory could not be allocated.\r
  @return other     a pointer to an EFI_FILE_PROTOCOL structure\r
**/\r
EFI_FILE_PROTOCOL*\r
CreateFileInterfaceFile(\r
  IN CONST EFI_FILE_PROTOCOL  *Template,\r
  IN CONST BOOLEAN            Unicode\r
  );\r
\r
#endif //_SHELL_FILE_HANDLE_WRAPPERS_HEADER_\r
\r