Clarify some definitions in HII Configure Routine Protocol

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9288 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h
index 584e70fcec4b82d652c3b25610276782b3452451..34beb2fbb257025cdba84b67a9fa24e317c12e99 100644 (file)
--- a/MdePkg/Include/Protocol/HiiConfigRouting.h
+++ b/MdePkg/Include/Protocol/HiiConfigRouting.h
@@ -56,8 +56,10 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
   @param This       Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
                     instance.\r
 \r
-  @param Request    A null-terminated Unicode string in\r
-                    <MultiConfigRequest> format.\r
+  @param Request    A null-terminated string in <MultiConfigRequest>\r
+                    format. If a NULL is passed in for the Request field,\r
+                    all of the settings being abstracted by this function\r
+                    will be returned in the Results field.\r
 \r
   @param Progress   On return, points to a character in the\r
                     Request string. Points to the string's null\r
@@ -68,11 +70,11 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
                     name / value pair) if the request was not\r
                     successful\r
 \r
-  @param Results    Null-terminated Unicode string in\r
-                    <MultiConfigAltResp> format which has all\r
-                    values filled in for the names in the\r
-                    Request string. String to be allocated by\r
-                    the called function.\r
+  @param Results    A null-terminated string in <ConfigAltResp> format\r
+                    which has all values filled in for the names in the\r
+                    Request string. If the Request string was NULL, the data\r
+                    returned is in <MultiConfigAltResp> format. String to be\r
+                    allocated by the called function.\r
 \r
   @retval EFI_SUCCESS             The Results string is filled with the\r
                                   values corresponding to all requested\r
@@ -120,12 +122,7 @@ EFI_STATUS
   This function allows the caller to request the current\r
   configuration for all of the current HII database. The results\r
   include both the current and alternate configurations as\r
-  described in ExtractConfig() above. Implementation note: This\r
-  call has deceptively few inputs but the implementation is likely\r
-  to be somewhat complex. The requirement is to scan all IFR in\r
-  the HII database to determine the list of names and then request\r
-  the configuration using the corresponding drivers.\r
-  EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig() interfaces below.\r
+  described in ExtractConfig() above. \r
   \r
   @param This     Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
   \r