ShellPkg/Include/Protocol/EfiShellParameters.h

   1 /** @file
   2   EFI Shell protocol as defined in the UEFI Shell 2.0 specification.
   3
   4   Copyright (c) 2006 - 2009, Intel Corporation
   5   All rights reserved. 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 __EFI_SHELL_PARAMETERS_PROTOCOL__
  16 #define __EFI_SHELL_PARAMETERS_PROTOCOL__
  17
  18 #define EFI_SHELL_PARAMETERS_PROTOCOL_GUID \
  19   { \
  20   0x752f3136, 0x4e16, 0x4fdc, { 0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca } \
  21   }
  22
  23 typedef struct _EFI_SHELL_PARAMETERS_PROTOCOL {
  24   ///
  25   /// Points to an Argc-element array of points to null-terminated strings containing
  26   /// the command-line parameters. The first entry in the array is always the full file
  27   /// path of the executable. Any quotation marks that were used to preserve
  28   /// whitespace have been removed.
  29   ///
  30   CHAR16 **Argv;
  31
  32   ///
  33   /// The number of elements in the Argv array.
  34   ///
  35   UINTN Argc;
  36
  37   ///
  38   /// The file handle for the standard input for this executable. This may be different
  39   /// from the ConInHandle in the EFI_SYSTEM_TABLE.
  40   ///
  41   EFI_FILE_HANDLE StdIn;
  42
  43   ///
  44   /// The file handle for the standard output for this executable. This may be different
  45   /// from the ConOutHandle in the EFI_SYSTEM_TABLE.
  46   ///
  47   EFI_FILE_HANDLE StdOut;
  48
  49   ///
  50   /// The file handle for the standard error output for this executable. This may be
  51   /// different from the StdErrHandle in the EFI_SYSTEM_TABLE.
  52   ///
  53   EFI_FILE_HANDLE StdErr;
  54 } EFI_SHELL_PARAMETERS_PROTOCOL;
  55
  56 extern EFI_GUID gEfiShellParametersProtocolGuid;
  57
  58 #endif