MdeModulePkg: Refine the services comments in EFI_PRINT2_PROTOCOL
authorHao Wu <hao.a.wu@intel.com>
Wed, 8 Feb 2017 02:48:14 +0000 (10:48 +0800)
committerHao Wu <hao.a.wu@intel.com>
Tue, 21 Feb 2017 05:55:28 +0000 (13:55 +0800)
For the following 8 services in EFI_PRINT2_PROTOCOL:
UNICODE_BS_PRINT
UNICODE_S_PRINT
UNICODE_BS_PRINT_ASCII_FORMAT
UNICODE_S_PRINT_ASCII_FORMAT
ASCII_BS_PRINT
ASCII_S_PRINT
ASCII_BS_PRINT_UNICODE_FORMAT
ASCII_S_PRINT_UNICODE_FORMAT

They will ASSERT when:
1) The input parameter 'StartOfBuffer' is NULL if 'BufferSize' indicates
at least 1 Ascii/Unicode character can be held.
2) The input parameter 'FormatString' is NULL if 'BufferSize' indicates at
least 1 Ascii/Unicode character can be held.
3) The input parameter 'FormatString' contains more than
PcdMaximum[Ascii|Unicode]StringLength Ascii/Unicode characters.
4) The produced string contains more than
PcdMaximum[Ascii|Unicode]StringLength Ascii/Unicode characters.

This commits removes the ASSERT case 4) and add the following new ASSERT
case:
4) The input parameter 'BufferSize' is greater than
(PcdMaximumAsciiStringLength * sizeof (CHAR8)) for Ascii format string or
(PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1) for Unicode format
string.

And for those ASSERT cases, 0 will be returned by those services.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
MdeModulePkg/Include/Protocol/Print2.h

index 1c127d55422a7ce9f111fb569718d8b69b3fc8c1..8cad6fdef05979cba042686fece701e0430e7311 100644 (file)
@@ -3,7 +3,7 @@
   This print protocol defines six basic print functions to \r
   print the format unicode and ascii string.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -26,35 +26,40 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef struct _EFI_PRINT2_PROTOCOL  EFI_PRINT2_PROTOCOL;\r
 \r
 /**\r
-  Produces a Null-terminated Unicode string in an output buffer, based on \r
-  a Null-terminated Unicode format string and a BASE_LIST argument list\r
-  \r
-  Produces a Null-terminated Unicode string in the output buffer \r
-  specified by StartOfBuffer and BufferSize.  \r
-  The Unicode string is produced by parsing the format string specified by FormatString.  \r
-  Arguments are pulled from the variable argument list specified by Marker.\r
-  Marker is constructed based on the contents of the format string.  \r
-  This function returns the number of Unicode characters in the produced output buffer, \r
-  not including the Null-terminator.\r
-  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+  Produces a Null-terminated Unicode string in an output buffer based on\r
+  a Null-terminated Unicode format string and a BASE_LIST argument list.\r
+\r
+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+  and BufferSize.\r
+  The Unicode string is produced by parsing the format string specified by FormatString.\r
+  Arguments are pulled from the variable argument list specified by Marker based on the\r
+  contents of the format string.\r
+  The number of Unicode characters in the produced output buffer is returned not including\r
+  the Null-terminator.\r
 \r
-  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
-  If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
-  If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
-  If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
-  Null-terminator, then ASSERT().\r
-\r
-  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
+\r
+  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated Unicode format string.\r
+  @param  FormatString    Null-terminated Unicode format string.\r
   @param  Marker          BASE_LIST marker for the variable argument list.\r
-  \r
-  @return The number of Unicode characters in the produced output buffer, not including the\r
+\r
+  @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -68,34 +73,41 @@ UINTN
   );\r
 \r
 /**\r
-  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
+  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
   Unicode format string and variable argument list.\r
-  \r
-  Produces a Null-terminated Unicode string in the output buffer \r
-  specified by StartOfBuffer and BufferSize.\r
+\r
+  This function is similar as snprintf_s defined in C11.\r
+\r
+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+  and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list based on the contents of the format string.\r
-  This function returns the number of Unicode characters in the produced output buffer, \r
-  not including the Null-terminator.\r
-  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+  The number of Unicode characters in the produced output buffer is returned not including\r
+  the Null-terminator.\r
+\r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
 \r
-  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
-  If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
-  If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
-  If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
-  Null-terminator, then ASSERT().\r
-\r
-  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
+  If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.\r
+\r
+  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated Unicode format string.\r
-  @param  ...             Variable argument list whose contents are accessed based on the \r
+  @param  FormatString    Null-terminated Unicode format string.\r
+  @param  ...             Variable argument list whose contents are accessed based on the\r
                           format string specified by FormatString.\r
-  \r
+\r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
@@ -110,33 +122,38 @@ UINTN
   );\r
 \r
 /**\r
-  Produces a Null-terminated Unicode string in an output buffer, based on a Null-terminated\r
-  ASCII format string and a BASE_LIST argument list\r
-  \r
-  Produces a Null-terminated Unicode string in the output buffer \r
-  specified by StartOfBuffer and BufferSize.\r
+  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
+  ASCII format string and a BASE_LIST argument list.\r
+\r
+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+  and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
-  Arguments are pulled from the variable argument list specified by Marker based on the \r
+  Arguments are pulled from the variable argument list specified by Marker based on the\r
   contents of the format string.\r
-  This function returns the number of Unicode characters in the produced output buffer, \r
-  not including the Null-terminator.\r
-  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+  The number of Unicode characters in the produced output buffer is returned not including\r
+  the Null-terminator.\r
+\r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
-  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
-  If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
-  If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
-  Null-terminator, then ASSERT().\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
-  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
+  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated ASCII format string.\r
+  @param  FormatString    Null-terminated ASCII format string.\r
   @param  Marker          BASE_LIST marker for the variable argument list.\r
-  \r
+\r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
@@ -151,33 +168,41 @@ UINTN
   );\r
 \r
 /**\r
-  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
-  ASCII format string and a variable argument list.\r
-  \r
-  Produces a Null-terminated Unicode string in the output buffer \r
-  specified by StartOfBuffer and BufferSize.\r
+  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
+  ASCII format string and  variable argument list.\r
+\r
+  This function is similar as snprintf_s defined in C11.\r
+\r
+  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
+  and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
-  Arguments are pulled from the variable argument list based on the contents of the format string.\r
-  This function returns the number of Unicode characters in the produced output buffer, \r
-  not including the Null-terminator.\r
-  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+  Arguments are pulled from the variable argument list based on the contents of the\r
+  format string.\r
+  The number of Unicode characters in the produced output buffer is returned not including\r
+  the Null-terminator.\r
 \r
-  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
-  If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
-  If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
+  If StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and BufferSize >\r
+  (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output\r
+  buffer is unmodified and 0 is returned.\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
-  Null-terminator, then ASSERT().\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
 \r
-  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
+  If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
+\r
+  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated ASCII format string.\r
-  @param  ...             Variable argument list whose contents are accessed based on the \r
+  @param  FormatString    Null-terminated ASCII format string.\r
+  @param  ...             Variable argument list whose contents are accessed based on the\r
                           format string specified by FormatString.\r
-  \r
+\r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
@@ -244,30 +269,34 @@ UINTN
 /**\r
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   ASCII format string and a BASE_LIST argument list.\r
-  \r
-  Produces a Null-terminated ASCII string in the output buffer \r
-  pecified by StartOfBuffer and BufferSize.\r
+\r
+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+  and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
-  Arguments are pulled from the variable argument list specified by Marker based on \r
+  Arguments are pulled from the variable argument list specified by Marker based on\r
   the contents of the format string.\r
-  This function returns the number of ASCII characters in the output buffer, \r
-  not including the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+  The number of ASCII characters in the produced output buffer is returned not including\r
+  the Null-terminator.\r
 \r
-  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
-  If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
-  If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
-  contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
-  Null-terminator, then ASSERT().\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
-  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
+  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated ASCII format string.\r
+  @param  FormatString    Null-terminated ASCII format string.\r
   @param  Marker          BASE_LIST marker for the variable argument list.\r
-  \r
+\r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
@@ -283,31 +312,38 @@ UINTN
 \r
 /**\r
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
-  ASCII format string and variable argument list.\r
-  \r
-  Produces a Null-terminated ASCII string in the output buffer \r
-  specified by StartOfBuffer and BufferSize.\r
+  ASCII format string and  variable argument list.\r
+\r
+  This function is similar as snprintf_s defined in C11.\r
+\r
+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+  and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
-  Arguments are pulled from the variable argument list based on the contents of the format string.\r
-  This function returns the number of ASCII characters in the output buffer, \r
-  not including the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+  Arguments are pulled from the variable argument list based on the contents of the\r
+  format string.\r
+  The number of ASCII characters in the produced output buffer is returned not including\r
+  the Null-terminator.\r
 \r
-  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
-  If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
-  If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
-  contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
-  Null-terminator, then ASSERT().\r
+  PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
-  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
+  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated ASCII format string.\r
-  @param  ...             Variable argument list whose contents are accessed based on the \r
+  @param  FormatString    Null-terminated ASCII format string.\r
+  @param  ...             Variable argument list whose contents are accessed based on the\r
                           format string specified by FormatString.\r
-   \r
+\r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
@@ -324,31 +360,36 @@ UINTN
 /**\r
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   Unicode format string and a BASE_LIST argument list.\r
-  \r
-  Produces a Null-terminated ASCII string in the output buffer \r
-  specified by StartOfBuffer and BufferSize.\r
+\r
+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+  and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
-  Arguments are pulled from the variable argument list specified by Marker based on \r
+  Arguments are pulled from the variable argument list specified by Marker based on\r
   the contents of the format string.\r
-  This function returns the number of ASCII characters in the output buffer, \r
-  not including the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+  The number of ASCII characters in the produced output buffer is returned not including\r
+  the Null-terminator.\r
 \r
-  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
-  If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
-  If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
   If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
-  If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
-  contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
-  Null-terminator, then ASSERT().\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
-  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
+  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated Unicode format string.\r
+  @param  FormatString    Null-terminated Unicode format string.\r
   @param  Marker          BASE_LIST marker for the variable argument list.\r
-  \r
+\r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
@@ -365,31 +406,39 @@ UINTN
 /**\r
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   Unicode format string and  variable argument list.\r
-  \r
-  Produces a Null-terminated ASCII string in the output buffer \r
-  specified by StartOfBuffer and BufferSize.\r
+\r
+  This function is similar as snprintf_s defined in C11.\r
+\r
+  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
+  and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
-  Arguments are pulled from the variable argument list based on the contents of the format string.\r
-  This function returns the number of ASCII characters in the output buffer, \r
-  not including the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
+  Arguments are pulled from the variable argument list based on the contents of the\r
+  format string.\r
+  The number of ASCII characters in the produced output buffer is returned not including\r
+  the Null-terminator.\r
+\r
+  If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
-  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
-  If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
-  If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
-  If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
-  contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
-  Null-terminator, then ASSERT().\r
+  If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is\r
+  unmodified and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and BufferSize >\r
+  (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer\r
+  is unmodified and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+  ASSERT(). Also, the output buffer is unmodified and 0 is returned.\r
+\r
+  If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
-  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
+  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated\r
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    Null-terminated Unicode format string.\r
-  @param  ...             Variable argument list whose contents are accessed based on the \r
+  @param  FormatString    Null-terminated Unicode format string.\r
+  @param  ...             Variable argument list whose contents are accessed based on the\r
                           format string specified by FormatString.\r
-  \r
+\r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r