Refine the comments to follow spec.

[mirror_edk2.git] / MdePkg / Include / Protocol / HiiConfigRouting.h

diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h
index ce38a2559cb2e4a8fb842375ce7da40366ea74ab..4423a5c04d1a414aff6a4cdd60666aff3f00fe19 100644 (file)
--- a/MdePkg/Include/Protocol/HiiConfigRouting.h
+++ b/MdePkg/Include/Protocol/HiiConfigRouting.h
@@ -124,11 +124,11 @@ EFI_STATUS
   \r
   @param This     Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
   \r
-  @param Results  A null-terminated string in <MultiConfigAltResp>\r
-                  format which has all values filled in for the\r
-                  names in the Request string.\r
-                  String to be allocated by this function.\r
-                  De-allocation is up to the caller.\r
+  @param  Results Null-terminated Unicode string in\r
+                  <MultiConfigAltResp> format which has all values\r
+                  filled in for the entirety of the current HII \r
+                  database. String to be allocated by the  called \r
+                  function. De-allocation is up to the caller.\r
   \r
   @retval EFI_SUCCESS             The Results string is filled with the\r
                                   values corresponding to all requested\r
@@ -305,8 +305,10 @@ EFI_STATUS
 \r
   @param BlockSize      The length of the Block in units of UINT8.\r
                         On input, this is the size of the Block. On\r
-                        output, if successful, contains the index of\r
-                        the last modified byte in the Block.\r
+                        output, if successful, contains the largest \r
+                        index of the modified byte in the Block, or\r
+                        the required buffer size if the Block is not\r
+                        large enough.\r
 \r
   @param Progress       On return, points to an element of the\r
                         ConfigResp string filled in with the offset\r
@@ -332,6 +334,9 @@ EFI_STATUS
   @retval EFI_NOT_FOUND          Target for the specified routing data was not found.\r
                                  Progress points to the "G" in "GUID" of the errant\r
                                  routing data.\r
+  @retval EFI_BUFFER_TOO_SMALL   Block not large enough. Progress undefined. \r
+                                 BlockSize is updated with the required buffer size.\r
+\r
 **/\r
 typedef\r
 EFI_STATUS\r