4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Serialize & Deserialize UEFI Variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Callback function for each variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context - Context as sent to the iteration function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] VariableName - Refer to RuntimeServices GetNextVariableName
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] VendorGuid - Refer to RuntimeServices GetNextVariableName
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Attributes - Refer to RuntimeServices GetVariable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataSize - Refer to RuntimeServices GetVariable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Data - Refer to RuntimeServices GetVariable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Continue iterating through the variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Any RETURN_ERROR Stop iterating through the variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *VARIABLE_SERIALIZATION_ITERATION_CALLBACK)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Creates a new variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Handle - Handle for a variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS - The variable serialization instance was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successfully created.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES - There we not enough resources to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync create the variable serialization instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Free memory associated with a variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle - Handle for a variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS - The variable serialization instance was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successfully freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER - Handle was not a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable serialization instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Creates a new variable serialization instance using the given
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync binary representation of the variables to fill the new instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Handle - Handle for a variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buffer - A buffer with the serialized representation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the variables. Must be the same format as produced
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by SerializeVariablesToBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Size - This is the size of the binary representation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS - The binary representation was successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync imported into a new variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES - There we not enough resources to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync create the new variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Iterates all variables found with RuntimeServices GetNextVariableName
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallbackFunction - Function called for each variable instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context - Passed to each call of CallbackFunction
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS - All variables were iterated without the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CallbackFunction returning an error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES - There we not enough resources to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync iterate through the variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Any of RETURN_ERROR indicates an error reading the variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or an error was returned from CallbackFunction
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VARIABLE_SERIALIZATION_ITERATION_CALLBACK CallbackFunction,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Iterates all variables found in the variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle - Handle for a variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallbackFunction - Function called for each variable instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context - Passed to each call of CallbackFunction
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS - All variables were iterated without the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CallbackFunction returning an error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES - There we not enough resources to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync iterate through the variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Any of RETURN_ERROR indicates an error reading the variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or an error was returned from CallbackFunction
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VARIABLE_SERIALIZATION_ITERATION_CALLBACK CallbackFunction,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets all variables found in the variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle - Handle for a variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS - All variables were set successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES - There we not enough resources to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set all the variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Any of RETURN_ERROR indicates an error reading the variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or in attempting to set a variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a variable to the variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle - Handle for a variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] VariableName - Refer to RuntimeServices GetVariable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] VendorGuid - Refer to RuntimeServices GetVariable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Attributes - Refer to RuntimeServices GetVariable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataSize - Refer to RuntimeServices GetVariable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Data - Refer to RuntimeServices GetVariable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS - All variables were set successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES - There we not enough resources to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync add the variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Serializes the variables known to this instance into the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync provided buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle - Handle for a variable serialization instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Buffer - A buffer to store the binary representation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] Size - On input this is the size of the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output this is the size of the binary representation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS - The binary representation was successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync completed and returned in the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES - There we not enough resources to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync save the variables to the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER - Handle was not a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable serialization instance or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Size or Buffer were NULL.