tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SetVariable() function comments updated to follow UEFI2.3 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9120 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
eric_tian 2009-08-19 02:48:50 +00:00
parent 73f8ef8c08
commit db27cda55e
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
MdePkg/Include/Uefi/UefiSpec.h
View File

@ -653,23 +653,28 @@ EFI_STATUS
/** /**
Sets the value of a variable. Sets the value of a variable.
@param VariableName A Null-terminated Unicode string that is the name of the @param VariableName A Null-terminated string that is the name of the vendor's variable.
vendor's variable. Each VariableName is unique for each VendorGuid. VariableName must
@param VendorGuid A unique identifier for the vendor. contain 1 or more characters. If VariableName is an empty string,
@param Attributes Attributes bitmask to set for the variable. then EFI_INVALID_PARAMETER is returned.
@param DataSize The size in bytes of the Data buffer. @param VendorGuid A unique identifier for the vendor.
@param Data The contents for the variable. @param Attributes Attributes bitmask to set for the variable.
@param DataSize The size in bytes of the Data buffer. A size of zero causes the
variable to be deleted.
@param Data The contents for the variable.
@retval EFI_SUCCESS The firmware has successfully stored the variable and its data as @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
defined by the Attributes. defined by the Attributes.
@retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
DataSize exceeds the maximum allowed. DataSize exceeds the maximum allowed.
@retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string. @retval EFI_INVALID_PARAMETER VariableName is an empty string.
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data. @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
@retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error. @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
@retval EFI_WRITE_PROTECTED The variable in question is read-only. @retval EFI_WRITE_PROTECTED The variable in question is read-only.
@retval EFI_WRITE_PROTECTED The variable in question cannot be deleted. @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
@retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure. @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
set but the AuthInfo does NOT pass the validation check carried out
by the firmware.
@retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found. @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
**/ **/