ShellPkg: Remove redundant quotes in file path string for Shell command parameters.

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

diff --git a/ShellPkg/Application/Shell/Shell.h b/ShellPkg/Application/Shell/Shell.h
index 1962dd63928d6071edbcb5556ee2ffafa25a7e1d..57518dfd29a81565d5ba86223aa779af0beaaeac 100644 (file)
--- a/ShellPkg/Application/Shell/Shell.h
+++ b/ShellPkg/Application/Shell/Shell.h
@@ -1,6 +1,7 @@
 /** @file\r
   function definitions for internal to shell functions.\r
 \r
+  (C) Copyright 2014, Hewlett-Packard Development Company, L.P.\r
   Copyright (c) 2009 - 2014, 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
@@ -230,14 +231,17 @@ ProcessCommandLine(
 \r
   @param[in] ImagePath          The path to the image for shell.  The first place to look for the startup script.\r
   @param[in] FilePath           The path to the file for shell.  The second place to look for the startup script.\r
+  @param[out] ExitStatus        The exit code of the script. Ignored if NULL.\r
+                                Invalid when this function returns an error.\r
 \r
   @retval EFI_SUCCESS           The variable is initialized.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 DoStartupScript(\r
-  IN EFI_DEVICE_PATH_PROTOCOL *ImagePath,\r
-  IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
+  IN  EFI_DEVICE_PATH_PROTOCOL *ImagePath,\r
+  IN  EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
+  OUT SHELL_STATUS             *ExitStatus\r
   );\r
 \r
 /**\r
@@ -282,7 +286,8 @@ AddLineToCommandHistory(
 \r
   This will determine if the command line represents an internal shell command or dispatch an external application.\r
 \r
-  @param[in] CmdLine  the command line to parse\r
+  @param[in]  CmdLine     the command line to parse\r
+  @param[out] ExitStatus  The exit status of the command. Ignored if NULL.\r
 \r
   @retval EFI_SUCCESS     the command was completed\r
   @retval EFI_ABORTED     the command's operation was aborted\r
@@ -290,7 +295,8 @@ AddLineToCommandHistory(
 EFI_STATUS\r
 EFIAPI\r
 RunCommand(\r
-  IN CONST CHAR16   *CmdLine\r
+  IN  CONST CHAR16         *CmdLine,\r
+  OUT       SHELL_STATUS   *ExitStatus\r
   );\r
 \r
 /**\r
@@ -314,13 +320,17 @@ IsValidCommandName(
   @param[in] Handle             The handle to the already opened file.\r
   @param[in] Name               The name of the script file.\r
 \r
+  @param[out] ExitStatus      The exit code of the script. Ignored if NULL.\r
+                              Invalid when this function returns an error.\r
+\r
   @retval EFI_SUCCESS           the script completed sucessfully\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 RunScriptFileHandle (\r
-  IN SHELL_FILE_HANDLE  Handle,\r
-  IN CONST CHAR16       *Name\r
+  IN  SHELL_FILE_HANDLE  Handle,\r
+  IN  CONST CHAR16       *Name,\r
+  OUT SHELL_STATUS       *ExitStatus\r
   );\r
 \r
 /**\r
@@ -331,17 +341,20 @@ RunScriptFileHandle (
   @param[in] CmdLine            the command line to run.\r
   @param[in] ParamProtocol      the shell parameters protocol pointer\r
 \r
+  @param[out] ExitStatus      The exit code of the script. Ignored if NULL.\r
+                              Invalid when this function returns an error.\r
+\r
   @retval EFI_SUCCESS           the script completed sucessfully\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 RunScriptFile (\r
-  IN CONST CHAR16                   *ScriptPath,\r
-  IN SHELL_FILE_HANDLE              Handle OPTIONAL,\r
-  IN CONST CHAR16                   *CmdLine,\r
-  IN EFI_SHELL_PARAMETERS_PROTOCOL  *ParamProtocol\r
+  IN  CONST CHAR16                   *ScriptPath,\r
+  IN  SHELL_FILE_HANDLE              Handle OPTIONAL,\r
+  IN  CONST CHAR16                   *CmdLine,\r
+  IN  EFI_SHELL_PARAMETERS_PROTOCOL  *ParamProtocol,\r
+  OUT SHELL_STATUS                   *ExitStatus\r
   );\r
 \r
-\r
 #endif //_SHELL_INTERNAL_HEADER_\r
 \r