According to the latest UEFI 2.3 errata B, the following changes are made:

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

diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h
index 09fb182442115a041a273035afecd18948796279..393129952c42f4735d4ae7501279bc2308f624c7 100644 (file)
--- a/MdePkg/Include/Protocol/HiiConfigRouting.h
+++ b/MdePkg/Include/Protocol/HiiConfigRouting.h
@@ -5,7 +5,7 @@
   information from configuration applications, routing the\r
   results to the appropriate drivers.\r
   \r
-  Copyright (c) 2006 - 2009, Intel Corporation\r
+  Copyright (c) 2006 - 2010, Intel Corporation\r
   All rights reserved. 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
@@ -56,10 +56,7 @@ 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 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
+  @param Request    A null-terminated string in <MultiConfigRequest> format.\r
 \r
   @param Progress   On return, points to a character in the\r
                     Request string. Points to the string's null\r
@@ -70,11 +67,9 @@ 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    A null-terminated string in <ConfigAltResp> format\r
+  @param Results    A null-terminated string in <MultiConfigAltResp> 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
+                    Request string.\r
 \r
   @retval EFI_SUCCESS             The Results string is filled with the\r
                                   values corresponding to all requested\r
@@ -228,7 +223,8 @@ EFI_STATUS
 \r
   @param Config     Filled-in configuration string. String\r
                     allocated by the function. Returned only if\r
-                    call is successful.\r
+                    call is successful. The null-terminated string \r
+                    will be <ConfigResp> format.\r
 \r
   @param Progress   A pointer to a string filled in with the\r
                     offset of the most recent '&' before the\r
@@ -349,7 +345,7 @@ EFI_STATUS
   a larger configuration string.\r
           \r
   @param This              A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
-  @param Configuration     A null-terminated string in <MultiConfigAltResp> format.\r
+  @param ConfigResp        A null-terminated string in <ConfigAltResp> format.\r
   @param Guid              A pointer to the GUID value to search for in the \r
                            routing portion of the ConfigResp string when retrieving \r
                            the requested data. If Guid is NULL, then all GUID \r
@@ -369,6 +365,7 @@ EFI_STATUS
   @param AltCfgResp        A pointer to a buffer which will be allocated by the \r
                            function which contains the retrieved string as requested.  \r
                            This buffer is only allocated if the call was successful. \r
+                           The null-terminated string will be <ConfigResp> format.\r
   \r
   @retval EFI_SUCCESS             The request succeeded. The requested data was extracted \r
                                   and placed in the newly allocated AltCfgResp buffer.\r
@@ -380,7 +377,7 @@ typedef
 EFI_STATUS \r
 (EFIAPI * EFI_HII_GET_ALT_CFG)(\r
   IN  CONST EFI_HII_CONFIG_ROUTING_PROTOCOL    *This, \r
-  IN  CONST EFI_STRING                         Configuration, \r
+  IN  CONST EFI_STRING                         ConfigResp, \r
   IN  CONST EFI_GUID                           *Guid, \r
   IN  CONST EFI_STRING                         Name, \r
   IN  CONST EFI_DEVICE_PATH_PROTOCOL           *DevicePath,  \r