Merged in the following trackers from EDK:

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

diff --git a/MdePkg/Include/Protocol/HiiString.h b/MdePkg/Include/Protocol/HiiString.h
index e120e9e470e0fc43c813d63d35d8d0621249fd78..0a522c2785d7b27b24658943e6039566ba20fb8d 100644 (file)
--- a/MdePkg/Include/Protocol/HiiString.h
+++ b/MdePkg/Include/Protocol/HiiString.h
@@ -1,7 +1,7 @@
 /** @file\r
   The file provides services to manipulate string data.\r
   \r
-  Copyright (c) 2006 - 2007, Intel Corporation\r
+  Copyright (c) 2006 - 2008, 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
@@ -101,14 +101,16 @@ EFI_STATUS
                     points to the length of the string, in\r
                     bytes.\r
   \r
-  @param StringFontInfo   Points to the string's font\r
-                          information or NULL if the string font\r
-                          information is not desired.\r
+  @param StringFontInfo  Points to a buffer that will be callee allocated and will \r
+                      have the string's font information into this buffer.  \r
+                      The caller is responsible for freeing this buffer.  \r
+                      If the parameter is NULL a buffer will not be allocated \r
+                      and the string font information will not be returned.\r
   \r
   @retval EFI_SUCCESS The string was returned successfully.\r
   \r
   @retval EFI_NOT_FOUND The string specified by StringId is not\r
-                        available.\r
+                        available. The specified PackageList is not in the database.\r
   \r
   @retval EFI_INVALID_LANGUAGE  The string specified by StringId\r
                                 is available but not in the\r
@@ -158,7 +160,7 @@ EFI_STATUS
   @retval EFI_SUCCESS   The string was successfully updated.\r
   \r
   @retval EFI_NOT_FOUND The string specified by StringId is not\r
-                        in the database.\r
+                        in the database. The specified PackageList is not in the database.\r
   \r
   @retval EFI_INVALID_PARAMETER The String or Language was NULL.\r
   \r
@@ -203,7 +205,8 @@ EFI_STATUS
                                 updated to contain the required\r
                                 size.\r
   \r
-  @retval EFI_INVALID_PARAMETER Languages is NULL.\r
+  @retval EFI_INVALID_PARAMETER Languages or LanguagesSize is NULL.\r
+  @retval EFI_NOT_FOUND The specified PackageList is not in the database.\r
 \r
 \r
 **/\r
@@ -261,6 +264,7 @@ EFI_STATUS
 \r
   @retval EFI_INVALID_PARAMETER FirstLanguage is NULL or\r
                                 SecondLanguage is NULL.\r
+  @retval EFI_NOT_FOUND The specified PackageList is not in the database.\r
 \r
 **/\r
 typedef\r