MdePkg: Update comments for GetNextVariableName to follow UEFI 2.7

"The size must be large enough to fit input string supplied in
VariableName buffer" is added in the description for VariableNameSize.
And two cases of EFI_INVALID_PARAMETER are added.
1. The input values of VariableName and VendorGuid are not a name and
   GUID of an existing variable.
2. Null-terminator is not found in the first VariableNameSize bytes of
   the input VariableName buffer.

This patch is to update comments for GetNextVariableName to follow them.

Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index eb662a35503c53f753e97c434a0db013353af78e..d39412748258520db69f8a4f028ac9c0f96a8c51 100644 (file)
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -661,7 +661,8 @@ EFI_STATUS
 /**\r
   Enumerates the current variable names.\r
 \r
-  @param[in, out]  VariableNameSize The size of the VariableName buffer.\r
+  @param[in, out]  VariableNameSize The size of the VariableName buffer. The size must be large\r
+                                    enough to fit input string supplied in VariableName buffer.\r
   @param[in, out]  VariableName     On input, supplies the last VariableName that was returned\r
                                     by GetNextVariableName(). On output, returns the Nullterminated\r
                                     string of the current variable.\r
@@ -672,9 +673,14 @@ EFI_STATUS
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_FOUND         The next variable was not found.\r
   @retval EFI_BUFFER_TOO_SMALL  The VariableNameSize is too small for the result.\r
+                                VariableNameSize has been updated with the size needed to complete the request.\r
   @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r
   @retval EFI_INVALID_PARAMETER VariableName is NULL.\r
   @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r
+  @retval EFI_INVALID_PARAMETER The input values of VariableName and VendorGuid are not a name and\r
+                                GUID of an existing variable.\r
+  @retval EFI_INVALID_PARAMETER Null-terminator is not found in the first VariableNameSize bytes of\r
+                                the input VariableName buffer.\r
   @retval EFI_DEVICE_ERROR      The variable could not be retrieved due to a hardware error.\r
 \r
 **/\r