diff options
| author | Eric Dong <eric.dong@intel.com> | 2013-08-20 07:08:25 +0000 |
|---|---|---|
| committer | ydong10 <ydong10@6f19259b-4bc3-4df7-8a09-765794883524> | 2013-08-20 07:08:25 +0000 |
| commit | 5795218e88685dea1991469ebabfe2887a3679bb (patch) | |
| tree | 20d109ac1da8460bf120ae423bf2b2266d5d0106 /MdePkg/Include/Protocol/HiiConfigRouting.h | |
| parent | 5a7b9bbe08a5dfc8de6f5091a4b140818604d403 (diff) | |
| download | edk2-platforms-5795218e88685dea1991469ebabfe2887a3679bb.tar.xz | |
Refine the comments to follow spec.
Signed-off-by: Eric Dong <eric.dong@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14572 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/HiiConfigRouting.h')
| -rw-r--r-- | MdePkg/Include/Protocol/HiiConfigRouting.h | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h index ce38a2559c..4423a5c04d 100644 --- a/MdePkg/Include/Protocol/HiiConfigRouting.h +++ b/MdePkg/Include/Protocol/HiiConfigRouting.h @@ -124,11 +124,11 @@ EFI_STATUS @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.
- @param Results A null-terminated string in <MultiConfigAltResp>
- format which has all values filled in for the
- names in the Request string.
- String to be allocated by this function.
- De-allocation is up to the caller.
+ @param Results Null-terminated Unicode string in
+ <MultiConfigAltResp> format which has all values
+ filled in for the entirety of the current HII
+ database. String to be allocated by the called
+ function. De-allocation is up to the caller.
@retval EFI_SUCCESS The Results string is filled with the
values corresponding to all requested
@@ -305,8 +305,10 @@ EFI_STATUS @param BlockSize The length of the Block in units of UINT8.
On input, this is the size of the Block. On
- output, if successful, contains the index of
- the last modified byte in the Block.
+ output, if successful, contains the largest
+ index of the modified byte in the Block, or
+ the required buffer size if the Block is not
+ large enough.
@param Progress On return, points to an element of the
ConfigResp string filled in with the offset
@@ -332,6 +334,9 @@ EFI_STATUS @retval EFI_NOT_FOUND Target for the specified routing data was not found.
Progress points to the "G" in "GUID" of the errant
routing data.
+ @retval EFI_BUFFER_TOO_SMALL Block not large enough. Progress undefined.
+ BlockSize is updated with the required buffer size.
+
**/
typedef
EFI_STATUS
|