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 - 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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, 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
+http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
///\r
/// Define the maximum number of characters that are required to\r
-/// encode a decimal, hexadecimal, GUID, or TIME value with a NULL \r
-/// terminator.\r
+/// encode with a NULL terminator a decimal, hexadecimal, GUID, \r
+/// or TIME value.\r
/// \r
/// Maximum Length Decimal String = 28\r
/// "-9,223,372,036,854,775,808"\r
\r
/**\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
+ a Null-terminated Unicode format string and a VA_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 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 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
+ 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
+ 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
@param FormatString 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
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\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
+ 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 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 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
+ 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
+ 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
@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
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\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
@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 A null-terminated Unicode format string.\r
+ @param ... The 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
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\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 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 not aligned on a 16-bit boundary, then ASSERT().\r
If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\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
+ 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
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 A null-terminated ASCII 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
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 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 not aligned on a 16-bit boundary, then ASSERT().\r
If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\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
+ 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
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 Marker BASE_LIST marker for the variable argument list.\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
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\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
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 not aligned on a 16-bit boundary, then ASSERT().\r
If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\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
+ contains more than PcdMaximumUnicodeStringLength Unicode characters, the\r
Null-terminator, then ASSERT().\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 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
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
Converts the decimal number specified by Value to a Null-terminated Unicode \r
string specified by Buffer containing at most Width characters. No padding of spaces \r
is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
- The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
+ The number of Unicode characters in Buffer is returned, not including the Null-terminator.\r
If the conversion contains more than Width characters, then only the first\r
Width characters are returned, and the total number of characters \r
required to perform the conversion is returned.\r
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
\r
- @param Buffer Pointer to the output buffer for the produced Null-terminated\r
+ @param Buffer The pointer to the output buffer for the produced Null-terminated\r
Unicode string.\r
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
@param Value The 64-bit signed value to convert to a string.\r
@param Width The maximum number of Unicode characters to place in Buffer, not including\r
the Null-terminator.\r
\r
- @return The number of Unicode characters in Buffer not including the Null-terminator.\r
+ @return The number of Unicode characters in Buffer, not including the Null-terminator.\r
\r
**/\r
UINTN\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
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 PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\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
+ contains more than PcdMaximumAsciiStringLength ASCII 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
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 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
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\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
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 PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\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
+ contains more than PcdMaximumAsciiStringLength ASCII 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
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 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
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\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
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 PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\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
+ contains more than PcdMaximumAsciiStringLength ASCII 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
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 A null-terminated ASCII format string.\r
+ @param ... The 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
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\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
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 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\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
+ contains more than PcdMaximumAsciiStringLength ASCII 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
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 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
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\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
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 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\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
+ contains more than PcdMaximumAsciiStringLength ASCII 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
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 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
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\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
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 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\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
+ contains more than PcdMaximumAsciiStringLength ASCII 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
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 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
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
specified by Buffer containing at most Width characters. No padding of spaces \r
is ever performed.\r
If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
- The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
+ The number of ASCII characters in Buffer is returned, not including the Null-terminator.\r
If the conversion contains more than Width characters, then only the first Width\r
characters are returned, and the total number of characters required to perform\r
the conversion is returned.\r
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
\r
- @param Buffer Pointer to the output buffer for the produced Null-terminated\r
+ @param Buffer A pointer to the output buffer for the produced Null-terminated\r
ASCII string.\r
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
@param Value The 64-bit signed value to convert to a string.\r
@param Width The maximum number of ASCII characters to place in Buffer, not including\r
the Null-terminator.\r
\r
- @return The number of ASCII characters in Buffer not including the Null-terminator.\r
+ @return The number of ASCII characters in Buffer, not including the Null-terminator.\r
\r
**/\r
UINTN\r
projects / mirror_edk2.git / blobdiff