diff options
| author | Star Zeng <star.zeng@intel.com> | 2017-06-22 14:17:19 +0800 |
|---|---|---|
| committer | Star Zeng <star.zeng@intel.com> | 2017-06-27 13:57:38 +0800 |
| commit | 6ca2bfa5e8bac16341fb57abfee65fda96ac87dd (patch) | |
| tree | f6f30f2f7cd4c465fd379b1aaff26b10102c97e3 /MdePkg/Include/Uefi | |
| parent | 980af1eb0b7ad7a55fc51231a7fd537529319371 (diff) | |
| download | edk2-6ca2bfa5e8bac16341fb57abfee65fda96ac87dd.tar.gz edk2-6ca2bfa5e8bac16341fb57abfee65fda96ac87dd.tar.bz2 edk2-6ca2bfa5e8bac16341fb57abfee65fda96ac87dd.zip | |
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>
Diffstat (limited to 'MdePkg/Include/Uefi')
| -rw-r--r-- | MdePkg/Include/Uefi/UefiSpec.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h index eb662a3550..d394127482 100644 --- a/MdePkg/Include/Uefi/UefiSpec.h +++ b/MdePkg/Include/Uefi/UefiSpec.h @@ -661,7 +661,8 @@ EFI_STATUS /**
Enumerates the current variable names.
- @param[in, out] VariableNameSize The size of the VariableName buffer.
+ @param[in, out] VariableNameSize The size of the VariableName buffer. The size must be large
+ enough to fit input string supplied in VariableName buffer.
@param[in, out] VariableName On input, supplies the last VariableName that was returned
by GetNextVariableName(). On output, returns the Nullterminated
string of the current variable.
@@ -672,9 +673,14 @@ EFI_STATUS @retval EFI_SUCCESS The function completed successfully.
@retval EFI_NOT_FOUND The next variable was not found.
@retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
+ VariableNameSize has been updated with the size needed to complete the request.
@retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
@retval EFI_INVALID_PARAMETER VariableName is NULL.
@retval EFI_INVALID_PARAMETER VendorGuid is NULL.
+ @retval EFI_INVALID_PARAMETER The input values of VariableName and VendorGuid are not a name and
+ GUID of an existing variable.
+ @retval EFI_INVALID_PARAMETER Null-terminator is not found in the first VariableNameSize bytes of
+ the input VariableName buffer.
@retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
**/
|