ShellPkg: Clean up source files

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

diff --git a/ShellPkg/Application/Shell/ShellEnvVar.h b/ShellPkg/Application/Shell/ShellEnvVar.h
index dd88b29fa040e23083219435bed8d566a66f28b1..0684516a5c192c2348955cafac009533ac8bffd4 100644 (file)
--- a/ShellPkg/Application/Shell/ShellEnvVar.h
+++ b/ShellPkg/Application/Shell/ShellEnvVar.h
@@ -6,7 +6,7 @@
 //#include <Library/UefiRuntimeServicesTableLib.h>\r
 \r
 \r
-  Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2018, 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
@@ -34,19 +34,18 @@ extern ENV_VAR_LIST    gShellEnvVarList;
 \r
 \r
 /**\r
-  Reports whether an environment variable is Volatile or Non-Volatile\r
-\r
-  This will use the Runtime Services call GetVariable to to search for the variable.\r
+  Reports whether an environment variable is Volatile or Non-Volatile.\r
 \r
   @param EnvVarName             The name of the environment variable in question\r
+  @param Volatile               Return TRUE if the environment variable is volatile\r
 \r
-  @retval TRUE                  This environment variable is Volatile\r
-  @retval FALSE                 This environment variable is NON-Volatile\r
+  @retval EFI_SUCCESS           The volatile attribute is returned successfully\r
+  @retval others                Some errors happened.\r
 **/\r
-BOOLEAN\r
-EFIAPI\r
+EFI_STATUS\r
 IsVolatileEnv (\r
-  IN CONST CHAR16 *EnvVarName\r
+  IN CONST CHAR16 *EnvVarName,\r
+  OUT BOOLEAN     *Volatile\r
   );\r
 \r
 /**\r
@@ -157,7 +156,6 @@ IsVolatileEnv (
   @retval EFI_SUCCESS           the list was created sucessfully.\r
 **/\r
 EFI_STATUS\r
-EFIAPI\r
 GetEnvironmentVariableList(\r
   IN OUT LIST_ENTRY *List\r
   );\r
@@ -175,7 +173,6 @@ GetEnvironmentVariableList(
   @retval EFI_SUCCESS           The list was Set sucessfully.\r
 **/\r
 EFI_STATUS\r
-EFIAPI\r
 SetEnvironmentVariableList(\r
   IN LIST_ENTRY *List\r
   );\r
@@ -196,7 +193,6 @@ SetEnvironmentVariableList(
   @sa SetEnvironmentVariableList\r
 **/\r
 EFI_STATUS\r
-EFIAPI\r
 SetEnvironmentVariables(\r
   IN CONST CHAR16 **Environment\r
   );\r
@@ -207,7 +203,6 @@ SetEnvironmentVariables(
   @param[in] List               The pointer to pointer to list.\r
 **/\r
 VOID\r
-EFIAPI\r
 FreeEnvironmentVariableList(\r
   IN LIST_ENTRY *List\r
   );\r
@@ -241,11 +236,14 @@ ShellFindEnvVarInList (
   @param Key        The name of the environment variable.\r
   @param Value      The value of environment variable.\r
   @param ValueSize  The size in bytes of the environment variable\r
-                    including the tailing CHAR_NELL\r
+                    including the tailing CHAR_NULL\r
   @param Atts       The attributes of the variable.\r
 \r
+  @retval EFI_SUCCESS  The environment variable was added to list successfully.\r
+  @retval others       Some errors happened.\r
+\r
 **/\r
-VOID\r
+EFI_STATUS\r
 ShellAddEnvVarToList (\r
   IN CONST CHAR16     *Key,\r
   IN CONST CHAR16     *Value,\r
@@ -268,9 +266,9 @@ ShellRemvoeEnvVarFromList (
   );\r
 \r
 /**\r
-  Initialize the gShellEnvVarList and cache all Shell-Guid-based environment \r
+  Initialize the gShellEnvVarList and cache all Shell-Guid-based environment\r
   variables.\r
-  \r
+\r
 **/\r
 EFI_STATUS\r
 ShellInitEnvVarList (\r