Update comments by UEFI approved Errata revision 'B'.

[mirror_edk2.git] / MdePkg / Include / Protocol / UserManager.h

diff --git a/MdePkg/Include/Protocol/UserManager.h b/MdePkg/Include/Protocol/UserManager.h
index edd07221ad78835c66abb01ec977c75250752963..35d7e4dbb3761f1f68f08ea40751caf0b6db6be3 100644 (file)
--- a/MdePkg/Include/Protocol/UserManager.h
+++ b/MdePkg/Include/Protocol/UserManager.h
@@ -410,7 +410,7 @@ EFI_STATUS
   with the user information record handle following UserInfo and continues until either the \r
   information is found or there are no more user profiles.\r
   A match occurs when the Info.InfoType field matches the user information record type and the \r
-  user information record data matches the portion of Info passed the EFI_USER_INFO header.\r
+  user information record data matches the portion of Info.\r
 \r
   @param[in]     This      Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
   @param[in,out] User      On entry, points to the previously returned user profile handle or NULL to start \r
@@ -421,14 +421,16 @@ EFI_STATUS
                            information record or NULL if not found. Can be NULL, in which case only one user \r
                            information record per user can be returned. \r
   @param[in]     Info      Points to the buffer containing the user information to be compared to the user \r
-                           information record. If NULL, then only the user information record type is compared. \r
+                           information record. If the user information record data is empty, then only the user \r
+                           information record type is compared. \r
                            If InfoSize is 0, then the user information record must be empty.\r
 \r
   @param[in]     InfoSize  The size of Info, in bytes. \r
 \r
-  @retval EFI_SUCCESS      User information was found. User points to the user profile handle and \r
-                           UserInfo points to the user information handle.\r
-  @retval EFI_NOT_FOUND    User information was not found. User points to NULL and UserInfo points to NULL.\r
+  @retval EFI_SUCCESS           User information was found. User points to the user profile handle and UserInfo\r
+                                points to the user information handle.\r
+  @retval EFI_NOT_FOUND         User information was not found. User points to NULL and UserInfo points to NULL.\r
+  @retval EFI_INVALID_PARAMETER User is NULL. Or Info is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -489,6 +491,9 @@ EFI_STATUS
   @retval EFI_ACCESS_DENIED     The information about the specified user cannot be accessed by the current user.\r
   @retval EFI_BUFFER_TOO_SMALL  The number of bytes specified by *InfoSize is too small to hold \r
                                 the returned data. The actual size required is returned in *InfoSize.\r
+  @retval EFI_NOT_FOUND         User does not refer to a valid user profile or UserInfo does not refer to a valid\r
+                                user info handle.\r
+  @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.\r
 **/  \r
 typedef\r
 EFI_STATUS\r
@@ -524,6 +529,9 @@ EFI_STATUS
   @retval EFI_ACCESS_DENIED       The record is exclusive.\r
   @retval EFI_SECURITY_VIOLATION  The current user does not have permission to change the specified \r
                                   user profile or user information record.\r
+  @retval EFI_NOT_FOUND           User does not refer to a valid user profile or UserInfo does not refer to a valid\r
+                                  user info handle.\r
+  @retval EFI_INVALID_PARAMETER   UserInfo is NULL or Info is NULL. \r
 **/  \r
 typedef\r
 EFI_STATUS\r
@@ -563,15 +571,13 @@ EFI_STATUS
   handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information \r
   record handle until there are no more, at which point UserInfo will point to NULL. \r
 \r
-  Note: in-consistency between code and the UEFI 2.3 specification that the type of the User parameter\r
-  is EFI_USER_PROFILE_HANDLE. It should be spec error and wait for spec update.\r
-\r
-  @param[in]     This      Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
-  @param[in]     User      Handle of the user whose information will be deleted.\r
-  @param[in,out] UserInfo  Handle of the user information to remove.\r
+  @param[in]     This           Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
+  @param[in]     User           Handle of the user whose information will be deleted.\r
+  @param[in,out] UserInfo       Handle of the user information to remove.\r
 \r
-  @retval EFI_SUCCESS      User information returned.\r
-  @retval EFI_NOT_FOUND    No more user information found.\r
+  @retval EFI_SUCCESS           User information returned.\r
+  @retval EFI_NOT_FOUND         No more user information found.\r
+  @retval EFI_INVALID_PARAMETER UserInfo is NULL.\r
 **/ \r
 typedef\r
 EFI_STATUS\r