MdePkg/BasePrintLib: Refine the SPrint functions

[mirror_edk2.git] / MdePkg / Include / Library / PrintLib.h

diff --git a/MdePkg/Include/Library/PrintLib.h b/MdePkg/Include/Library/PrintLib.h
index fcaacde6522a763893eda0bfd299557790c2f96a..5f663239b7bc9b90e5a7a3812fd6d63298fb60b2 100644 (file)
--- a/MdePkg/Include/Library/PrintLib.h
+++ b/MdePkg/Include/Library/PrintLib.h
@@ -2,7 +2,7 @@
   Provides services to print a formatted string to a buffer. All combinations of\r
   Unicode and ASCII strings are supported.\r
 \r
-Copyright (c) 2006 - 2015, 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
@@ -204,36 +204,42 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define RADIX_HEX         0x80\r
 \r
 /**\r
-  Produces a Null-terminated Unicode string in an output buffer based on \r
+  Produces a Null-terminated Unicode string in an output buffer based on\r
   a Null-terminated Unicode format string and a VA_LIST argument list.\r
-  \r
+\r
+  This function is similar as vsnprintf_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 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
+  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
-  If BufferSize is 0 or 1, then no output buffer is produced 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\r
-  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    A Null-terminated Unicode format string.\r
   @param  Marker          VA_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
@@ -247,36 +253,40 @@ UnicodeVSPrint (
   );\r
 \r
 /**\r
-  Produces a Null-terminated Unicode string in an output buffer based on \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
+\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
+  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
-  If BufferSize is 0 or 1, then no output buffer is produced 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\r
-  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    A 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
@@ -290,36 +300,42 @@ UnicodeBSPrint (
   );\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
+\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
-  The number of Unicode characters in the produced output buffer is returned, not including\r
+  The number of Unicode characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0 or 1, then no output buffer is produced 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
+  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().\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
+  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
+  @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    A null-terminated Unicode format string.\r
-  @param  ...             The variable argument list whose contents are accessed based on the \r
+  @param  FormatString    A 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
-  @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
@@ -334,33 +350,39 @@ UnicodeSPrint (
 \r
 /**\r
   Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
-  ASCII format string and a VA_LIST argument list\r
-  \r
+  ASCII format string and a VA_LIST argument list.\r
+\r
+  This function is similar as vsnprintf_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 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
-  The number of Unicode characters in the produced output buffer is returned, not including\r
+  The number of Unicode characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0 or 1, then no output buffer is produced 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 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\r
-  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    A null-terminated ASCII format string.\r
+  @param  FormatString    A Null-terminated ASCII format string.\r
   @param  Marker          VA_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
@@ -376,34 +398,38 @@ UnicodeVSPrintAsciiFormat (
 \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
+  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
-  The number of Unicode characters in the produced output buffer is returned, not including\r
+  The number of Unicode characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0 or 1, then no output buffer is produced 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 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\r
-  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    A null-terminated ASCII format string.\r
-  @param  Marker          A 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
+  @param  FormatString    A Null-terminated ASCII 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
           Null-terminator.\r
 \r
 **/\r
@@ -417,36 +443,42 @@ UnicodeBSPrintAsciiFormat (
   );\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
   ASCII format string and  variable argument list.\r
-  \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 \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 number of Unicode characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0 or 1, then no output buffer is produced 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 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\r
-  ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
-  contains more than PcdMaximumUnicodeStringLength Unicode characters, 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    A null-terminated ASCII format string.\r
-  @param  ...             Variable argument list whose contents are accessed based on the \r
+  @param  FormatString    A 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
-  @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
@@ -512,32 +544,37 @@ UnicodeValueToString (
 /**\r
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   ASCII format string and a VA_LIST argument list.\r
-  \r
+\r
+  This function is similar as vsnprintf_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 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
-  The number of ASCII characters in the produced output buffer is returned, not including\r
+  The number of ASCII characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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\r
-  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    A null-terminated ASCII format string.\r
+  @param  FormatString    A Null-terminated ASCII format string.\r
   @param  Marker          VA_LIST marker for the variable argument list.\r
-  \r
-  @return The number of ASCII characters in the produced output buffer, not including the\r
+\r
+  @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -553,32 +590,35 @@ AsciiVSPrint (
 /**\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
+\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
-  The number of ASCII characters in the produced output buffer is returned, not including\r
+  The number of ASCII characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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\r
-  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    A null-terminated ASCII format string.\r
+  @param  FormatString    A Null-terminated ASCII format string.\r
   @param  Marker          BASE_LIST marker for the variable argument list.\r
-  \r
-  @return The number of ASCII characters in the produced output buffer, not including the\r
+\r
+  @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -594,33 +634,38 @@ AsciiBSPrint (
 /**\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
+\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 \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 number of ASCII characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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\r
-  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    A null-terminated ASCII format string.\r
-  @param  ...             The variable argument list whose contents are accessed based on the \r
+  @param  FormatString    A 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
-  @return The number of ASCII characters in the produced output buffer, not including the\r
+\r
+  @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -636,33 +681,39 @@ AsciiSPrint (
 /**\r
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   Unicode format string and a VA_LIST argument list.\r
-  \r
+\r
+  This function is similar as vsnprintf_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 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
-  The number of ASCII characters in the produced output buffer is returned, not including\r
+  The number of ASCII characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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\r
-  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    A null-terminated Unicode format string.\r
+  @param  FormatString    A Null-terminated Unicode format string.\r
   @param  Marker          VA_LIST marker for the variable argument list.\r
-  \r
-  @return The number of ASCII characters in the produced output buffer, not including the\r
+\r
+  @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -678,33 +729,37 @@ AsciiVSPrintUnicodeFormat (
 /**\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
+\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
-  The number of ASCII characters in the produced output buffer is returned, not including\r
+  The number of ASCII characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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\r
-  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
-  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \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
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
-  @param  FormatString    A null-terminated Unicode format string.\r
+  @param  FormatString    A Null-terminated Unicode format string.\r
   @param  Marker          BASE_LIST marker for the variable argument list.\r
-  \r
-  @return The number of ASCII characters in the produced output buffer, not including the\r
+\r
+  @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -720,34 +775,40 @@ AsciiBSPrintUnicodeFormat (
 /**\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
+\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 \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 number of ASCII characters in the produced output buffer is returned not including\r
   the Null-terminator.\r
-  If BufferSize is 0, then no output buffer is produced and 0 is returned.\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\r
-  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    A null-terminated Unicode format string.\r
-  @param  ...             Variable argument list whose contents are accessed based on the \r
+  @param  FormatString    A 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
-  @return The number of ASCII characters in the produced output buffer, not including the\r
+\r
+  @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
 **/\r
@@ -813,8 +874,12 @@ AsciiValueToString (
   Returns the number of characters that would be produced by if the formatted \r
   output were produced not including the Null-terminator.\r
 \r
-  If Format is NULL, then ASSERT().\r
-  If Format 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 FormatString is NULL, then ASSERT() and 0 is returned.\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more\r
+  than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+  Null-terminator, then ASSERT() and 0 is returned.\r
 \r
   @param[in]  FormatString    A Null-terminated Unicode format string.\r
   @param[in]  Marker          VA_LIST marker for the variable argument list.\r
@@ -833,7 +898,10 @@ SPrintLength (
   Returns the number of characters that would be produced by if the formatted \r
   output were produced not including the Null-terminator.\r
 \r
-  If Format is NULL, then ASSERT().\r
+  If FormatString is NULL, then ASSERT() and 0 is returned.\r
+  If PcdMaximumAsciiStringLength is not zero, and FormatString contains more\r
+  than PcdMaximumAsciiStringLength Ascii characters not including the\r
+  Null-terminator, then ASSERT() and 0 is returned.\r
 \r
   @param[in]  FormatString    A Null-terminated ASCII format string.\r
   @param[in]  Marker          VA_LIST marker for the variable argument list.\r