This print protocol defines six basic print functions to \r
print the format unicode and ascii string.\r
\r
This print protocol defines six basic print functions to \r
print the format unicode and ascii string.\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
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 an output buffer, based on \r
a Null-terminated Unicode format string and a BASE_LIST argument list\r
\r
- Arguments are pulled from the variable argument list specified by Marker. Marker is constructed based on the \r
- contents of the format string. \r
- This function returns the number of Unicode characters in the produced output buffer, not including\r
- the Null-terminator.\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
\r
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\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 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 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 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
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
OUT CHAR16 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR16 *FormatString,\r
OUT CHAR16 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR16 *FormatString,\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 an output buffer based on a Null-terminated \r
Unicode format string and variable argument list.\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 format string.\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, not including\r
- the Null-terminator.\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
\r
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\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 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 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 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
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
OUT CHAR16 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR16 *FormatString,\r
OUT CHAR16 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR16 *FormatString,\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 an output buffer, based on a Null-terminated\r
ASCII format string and a BASE_LIST argument list\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 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
- This function returns the number of Unicode characters in the produced output buffer, not including\r
- the Null-terminator.\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
\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 PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\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 PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\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
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
OUT CHAR16 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR8 *FormatString,\r
OUT CHAR16 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR8 *FormatString,\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 an output buffer based on a Null-terminated \r
ASCII format string and a variable argument list.\r
\r
- Arguments are pulled from the variable argument list based on the contents of the \r
- format string.\r
- This function returns the number of Unicode characters in the produced output buffer, not including\r
- the Null-terminator.\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
\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 PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\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 PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\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
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
OUT CHAR16 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR8 *FormatString,\r
OUT CHAR16 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR8 *FormatString,\r
If Width is 0, PREFIX_ZERO is ignored in Flags.\r
If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
are inserted every 3rd digit starting from the right.\r
If Width is 0, PREFIX_ZERO is ignored in Flags.\r
If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
are inserted every 3rd digit starting from the right.\r
If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
then Buffer is padded with '0' characters so the combination of the optional '-' \r
sign character, '0' characters, digit characters for Value, and the Null-terminator\r
add up to Width characters.\r
If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
then Buffer is padded with '0' characters so the combination of the optional '-' \r
sign character, '0' characters, digit characters for Value, and the Null-terminator\r
add up to Width characters.\r
If Buffer is NULL, then ASSERT().\r
If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
If unsupported bits are set in Flags, then ASSERT().\r
If Buffer is NULL, then ASSERT().\r
If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
If unsupported bits are set in Flags, then ASSERT().\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
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
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 an output buffer based on a Null-terminated\r
ASCII format string and a BASE_LIST argument list.\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 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
- This function returns the number of ASCII characters in the output buffer, not including\r
- the Null-terminator.\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
\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
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
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 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
OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR8 *FormatString,\r
OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR8 *FormatString,\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 an output buffer based on a Null-terminated\r
ASCII format string and variable argument list.\r
\r
- Arguments are pulled from the variable argument list based on the contents of the \r
- format string.\r
- This function returns the number of ASCII characters in the output buffer, not including\r
- the Null-terminator.\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
\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
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
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 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
OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR8 *FormatString,\r
OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR8 *FormatString,\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 an output buffer based on a Null-terminated\r
Unicode format string and a BASE_LIST argument list.\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 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
- This function returns the number of ASCII characters in the output buffer, not including\r
- the Null-terminator.\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
\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
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 PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\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 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
OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR16 *FormatString,\r
OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR16 *FormatString,\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 an output buffer based on a Null-terminated\r
Unicode format string and variable argument list.\r
\r
- Arguments are pulled from the variable argument list based on the contents of the \r
- format string.\r
- This function returns the number of ASCII characters in the output buffer, not including\r
- the Null-terminator.\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
\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 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 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 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 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
OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR16 *FormatString,\r
OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN CONST CHAR16 *FormatString,\r
Converts a decimal value to a Null-terminated ASCII string.\r
\r
Converts the decimal number specified by Value to a Null-terminated ASCII string \r
Converts a decimal value to a Null-terminated ASCII string.\r
\r
Converts the decimal number specified by Value to a Null-terminated ASCII string \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
If the conversion contains more than Width characters, then only the first Width\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
If the conversion contains more than Width characters, then only the first Width\r
If Width is 0, PREFIX_ZERO is ignored in Flags.\r
If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
are inserted every 3rd digit starting from the right.\r
If Width is 0, PREFIX_ZERO is ignored in Flags.\r
If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
are inserted every 3rd digit starting from the right.\r
If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
then Buffer is padded with '0' characters so the combination of the optional '-' \r
sign character, '0' characters, digit characters for Value, and the Null-terminator\r
If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
then Buffer is padded with '0' characters so the combination of the optional '-' \r
sign character, '0' characters, digit characters for Value, and the Null-terminator\r
\r
If Buffer is NULL, then ASSERT().\r
If unsupported bits are set in Flags, then ASSERT().\r
\r
If Buffer is NULL, then ASSERT().\r
If unsupported bits are set in Flags, then ASSERT().\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
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