[mirror_edk2.git] / ShellPkg / Include / Protocol / EfiShellParameters.h

/** @file\r
  EFI Shell protocol as defined in the UEFI Shell 2.0 specification.\r
\r
  Copyright (c) 2006 - 2010, 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
#include <ShellBase.h>\r
\r
#ifndef __EFI_SHELL_PARAMETERS_PROTOCOL__\r
#define __EFI_SHELL_PARAMETERS_PROTOCOL__\r
\r
#define EFI_SHELL_PARAMETERS_PROTOCOL_GUID \\r
  { \\r
  0x752f3136, 0x4e16, 0x4fdc, { 0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca } \\r
  }\r
\r
typedef struct _EFI_SHELL_PARAMETERS_PROTOCOL {\r
  ///\r
  /// Points to an Argc-element array of points to NULL-terminated strings containing\r
  /// the command-line parameters. The first entry in the array is always the full file\r
  /// path of the executable. Any quotation marks that were used to preserve\r
  /// whitespace have been removed.\r
  ///\r
  CHAR16 **Argv;\r
\r
  ///\r
  /// The number of elements in the Argv array.\r
  ///\r
  UINTN Argc;\r
\r
  ///\r
  /// The file handle for the standard input for this executable. This may be different\r
  /// from the ConInHandle in EFI_SYSTEM_TABLE.\r
  ///\r
  SHELL_FILE_HANDLE StdIn;\r
\r
  ///\r
  /// The file handle for the standard output for this executable. This may be different\r
  /// from the ConOutHandle in EFI_SYSTEM_TABLE.\r
  ///\r
  SHELL_FILE_HANDLE StdOut;\r
\r
  ///\r
  /// The file handle for the standard error output for this executable. This may be\r
  /// different from the StdErrHandle in EFI_SYSTEM_TABLE.\r
  ///\r
  SHELL_FILE_HANDLE StdErr;\r
} EFI_SHELL_PARAMETERS_PROTOCOL;\r
\r
extern EFI_GUID gEfiShellParametersProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	EFI Shell protocol as defined in the UEFI Shell 2.0 specification.\r
	3	\r
	4	Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#include <ShellBase.h>\r
	16	\r
	17	#ifndef __EFI_SHELL_PARAMETERS_PROTOCOL__\r
	18	#define __EFI_SHELL_PARAMETERS_PROTOCOL__\r
	19	\r
	20	#define EFI_SHELL_PARAMETERS_PROTOCOL_GUID \\r
	21	{ \\r
	22	0x752f3136, 0x4e16, 0x4fdc, { 0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca } \\r
	23	}\r
	24	\r
	25	typedef struct _EFI_SHELL_PARAMETERS_PROTOCOL {\r
	26	///\r
	27	/// Points to an Argc-element array of points to NULL-terminated strings containing\r
	28	/// the command-line parameters. The first entry in the array is always the full file\r
	29	/// path of the executable. Any quotation marks that were used to preserve\r
	30	/// whitespace have been removed.\r
	31	///\r
	32	CHAR16 **Argv;\r
	33	\r
	34	///\r
	35	/// The number of elements in the Argv array.\r
	36	///\r
	37	UINTN Argc;\r
	38	\r
	39	///\r
	40	/// The file handle for the standard input for this executable. This may be different\r
	41	/// from the ConInHandle in EFI_SYSTEM_TABLE.\r
	42	///\r
	43	SHELL_FILE_HANDLE StdIn;\r
	44	\r
	45	///\r
	46	/// The file handle for the standard output for this executable. This may be different\r
	47	/// from the ConOutHandle in EFI_SYSTEM_TABLE.\r
	48	///\r
	49	SHELL_FILE_HANDLE StdOut;\r
	50	\r
	51	///\r
	52	/// The file handle for the standard error output for this executable. This may be\r
	53	/// different from the StdErrHandle in EFI_SYSTEM_TABLE.\r
	54	///\r
	55	SHELL_FILE_HANDLE StdErr;\r
	56	} EFI_SHELL_PARAMETERS_PROTOCOL;\r
	57	\r
	58	extern EFI_GUID gEfiShellParametersProtocolGuid;\r
	59	\r
	60	#endif\r