ArmPkg: Fixed GetEnvironmentVariable() when the UEFI Variable did not exist

[mirror_edk2.git] / ArmPkg / Include / Library / BdsLib.h

diff --git a/ArmPkg/Include/Library/BdsLib.h b/ArmPkg/Include/Library/BdsLib.h
index d16748da46f32818517a34585c3f150b524880c0..9fa687041860f2f74dbdcac2c9af6b676280d237 100644 (file)
--- a/ArmPkg/Include/Library/BdsLib.h
+++ b/ArmPkg/Include/Library/BdsLib.h
@@ -66,6 +66,23 @@ BdsConnectAllDrivers (
   VOID\r
   );\r
 \r
+/**\r
+  Return the value of a global variable defined by its VariableName.\r
+  The variable must be defined with the VendorGuid gEfiGlobalVariableGuid.\r
+\r
+  @param  VariableName          A Null-terminated string that is the name of the vendor's\r
+                                variable.\r
+  @param  DefaultValue          Value returned by the function if the variable does not exist\r
+  @param  DataSize              On input, the size in bytes of the return Data buffer.\r
+                                On output the size of data returned in Data.\r
+  @param  Value                 Value read from the UEFI Variable or copy of the default value\r
+                                if the UEFI Variable does not exist\r
+\r
+  @retval EFI_SUCCESS           All drivers have been connected\r
+  @retval EFI_NOT_FOUND         No handles match the search.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not resource pool memory to store the matching results.\r
+\r
+**/\r
 EFI_STATUS\r
 GetGlobalEnvironmentVariable (\r
   IN     CONST CHAR16*   VariableName,\r
@@ -74,6 +91,23 @@ GetGlobalEnvironmentVariable (
   OUT    VOID**          Value\r
   );\r
 \r
+/**\r
+  Return the value of the variable defined by its VariableName and VendorGuid\r
+\r
+  @param  VariableName          A Null-terminated string that is the name of the vendor's\r
+                                variable.\r
+  @param  VendorGuid            A unique identifier for the vendor.\r
+  @param  DefaultValue          Value returned by the function if the variable does not exist\r
+  @param  DataSize              On input, the size in bytes of the return Data buffer.\r
+                                On output the size of data returned in Data.\r
+  @param  Value                 Value read from the UEFI Variable or copy of the default value\r
+                                if the UEFI Variable does not exist\r
+\r
+  @retval EFI_SUCCESS           All drivers have been connected\r
+  @retval EFI_NOT_FOUND         No handles match the search.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not resource pool memory to store the matching results.\r
+\r
+**/\r
 EFI_STATUS\r
 GetEnvironmentVariable (\r
   IN     CONST CHAR16*   VariableName,\r