Refine parameter description according to PI 1.2 errata A.

[mirror_edk2.git] / MdePkg / Include / Ppi / ReadOnlyVariable2.h

diff --git a/MdePkg/Include/Ppi/ReadOnlyVariable2.h b/MdePkg/Include/Ppi/ReadOnlyVariable2.h
index 329266a87974a84bd8c6abe6851ada8d5a2cbdc7..d99d5af04772f99167ccc533abbd2e67e2f89a89 100644 (file)
--- a/MdePkg/Include/Ppi/ReadOnlyVariable2.h
+++ b/MdePkg/Include/Ppi/ReadOnlyVariable2.h
@@ -2,7 +2,7 @@
   This file declares Read-only Variable Service2 PPI.\r
   This ppi permits read-only access to the UEFI variable store during the PEI phase.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, 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
@@ -12,8 +12,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r
-  This PPI is defined in PI\r
-  Version 1.00.\r
+  This PPI is introduced in PI Version 1.0.\r
 \r
 **/\r
 \r
@@ -36,7 +35,7 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI  EFI_PEI_READ_ONLY_VARIABLE2_PPI
 \r
   @param  This                  A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
   @param  VariableName          A pointer to a null-terminated string that is the variable's name.\r
-  @param  VendorGuid            A pointer to an EFI_GUID that is the variable's GUID. The combination of\r
+  @param  VariableGuid          A pointer to an EFI_GUID that is the variable's GUID. The combination of\r
                                 VariableGuid and VariableName must be unique.\r
   @param  Attributes            If non-NULL, on return, points to the variable's attributes.\r
   @param  DataSize              On entry, points to the size in bytes of the Data buffer.\r
@@ -80,7 +79,7 @@ EFI_STATUS
   @param  VariableName      On entry, a pointer to a null-terminated string that is the variable's name.\r
                             On return, points to the next variable's null-terminated name string.\r
 \r
-  @param  VendorGuid        On entry, a pointer to an UEFI _GUID that is the variable's GUID. \r
+  @param  VariableGuid      On entry, a pointer to an EFI_GUID that is the variable's GUID. \r
                             On return, a pointer to the next variable's GUID.\r
 \r
   @retval EFI_SUCCESS           The variable was read successfully.\r
@@ -95,7 +94,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_NEXT_VARIABLE_NAME2)(\r
+(EFIAPI *EFI_PEI_GET_NEXT_VARIABLE_NAME2)(\r
   IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
   IN OUT    UINTN                           *VariableNameSize,\r
   IN OUT    CHAR16                          *VariableName,\r
@@ -107,14 +106,8 @@ EFI_STATUS
 /// variable services. \r
 ///\r
 struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI {\r
-  ///\r
-  /// A service to read the value of a particular variable using its name.\r
-  ///\r
-  EFI_PEI_GET_VARIABLE2       GetVariable;\r
-  ///\r
-  /// Find the next variable name in the variable store.\r
-  ///\r
-  EFI_PEI_NEXT_VARIABLE_NAME2 NextVariableName;\r
+  EFI_PEI_GET_VARIABLE2           GetVariable;\r
+  EFI_PEI_GET_NEXT_VARIABLE_NAME2 NextVariableName;\r
 };\r
 \r
 extern EFI_GUID gEfiPeiReadOnlyVariable2PpiGuid;\r