MdePkg/Library/BasePrintLib/PrintLib.c File Reference


Defines

#define ASSERT_UNICODE_BUFFER(Buffer)   ASSERT ((((UINTN) (Buffer)) & 0x01) == 0)

Functions

UINTN EFIAPI UnicodeVSPrint (OUT CHAR16 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR16 *FormatString, IN VA_LIST Marker)
UINTN EFIAPI UnicodeBSPrint (OUT CHAR16 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR16 *FormatString, IN BASE_LIST Marker)
UINTN EFIAPI UnicodeSPrint (OUT CHAR16 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR16 *FormatString,...)
UINTN EFIAPI UnicodeVSPrintAsciiFormat (OUT CHAR16 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR8 *FormatString, IN VA_LIST Marker)
UINTN EFIAPI UnicodeBSPrintAsciiFormat (OUT CHAR16 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR8 *FormatString, IN BASE_LIST Marker)
UINTN EFIAPI UnicodeSPrintAsciiFormat (OUT CHAR16 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR8 *FormatString,...)
UINTN EFIAPI UnicodeValueToString (IN OUT CHAR16 *Buffer, IN UINTN Flags, IN INT64 Value, IN UINTN Width)
UINTN EFIAPI AsciiVSPrint (OUT CHAR8 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR8 *FormatString, IN VA_LIST Marker)
UINTN EFIAPI AsciiBSPrint (OUT CHAR8 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR8 *FormatString, IN BASE_LIST Marker)
UINTN EFIAPI AsciiSPrint (OUT CHAR8 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR8 *FormatString,...)
UINTN EFIAPI AsciiVSPrintUnicodeFormat (OUT CHAR8 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR16 *FormatString, IN VA_LIST Marker)
UINTN EFIAPI AsciiBSPrintUnicodeFormat (OUT CHAR8 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR16 *FormatString, IN BASE_LIST Marker)
UINTN EFIAPI AsciiSPrintUnicodeFormat (OUT CHAR8 *StartOfBuffer, IN UINTN BufferSize, IN CONST CHAR16 *FormatString,...)
UINTN EFIAPI AsciiValueToString (OUT CHAR8 *Buffer, IN UINTN Flags, IN INT64 Value, IN UINTN Width)
UINTN EFIAPI SPrintLength (IN CONST CHAR16 *FormatString, IN VA_LIST Marker)
UINTN EFIAPI SPrintLengthAsciiFormat (IN CONST CHAR8 *FormatString, IN VA_LIST Marker)

Variables

VA_LIST gNullVaList

Detailed Description

Base Print Library instance implementation.

Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define ASSERT_UNICODE_BUFFER ( Buffer   )     ASSERT ((((UINTN) (Buffer)) & 0x01) == 0)


Function Documentation

UINTN EFIAPI AsciiBSPrint ( OUT CHAR8 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR8 FormatString,
IN BASE_LIST  Marker 
)

Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated ASCII format string and a BASE_LIST argument list.

Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer and BufferSize. The ASCII string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list specified by Marker based on the contents of the format string. The number of ASCII characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0, then no output buffer is produced and 0 is returned.

If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 0 and FormatString is NULL, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated ASCII format string.
Marker BASE_LIST marker for the variable argument list.
Returns:
The number of ASCII characters in the produced output buffer not including the Null-terminator.

References BasePrintLibSPrintMarker(), and gNullVaList.

UINTN EFIAPI AsciiBSPrintUnicodeFormat ( OUT CHAR8 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR16 FormatString,
IN BASE_LIST  Marker 
)

Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Unicode format string and a BASE_LIST argument list.

Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer and BufferSize. The ASCII string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list specified by Marker based on the contents of the format string. The number of ASCII characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0, then no output buffer is produced and 0 is returned.

If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 0 and FormatString is NULL, then ASSERT(). If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated Unicode format string.
Marker BASE_LIST marker for the variable argument list.
Returns:
The number of ASCII characters in the produced output buffer not including the Null-terminator.

References ASSERT_UNICODE_BUFFER, BasePrintLibSPrintMarker(), FORMAT_UNICODE, and gNullVaList.

UINTN EFIAPI AsciiSPrint ( OUT CHAR8 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR8 FormatString,
  ... 
)

Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated ASCII format string and variable argument list.

Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer and BufferSize. The ASCII string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list based on the contents of the format string. The number of ASCII characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0, then no output buffer is produced and 0 is returned.

If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 0 and FormatString is NULL, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated ASCII format string.
... Variable argument list whose contents are accessed based on the format string specified by FormatString.
Returns:
The number of ASCII characters in the produced output buffer not including the Null-terminator.

References AsciiVSPrint(), VA_END, and VA_START.

Referenced by DebugAssert().

UINTN EFIAPI AsciiSPrintUnicodeFormat ( OUT CHAR8 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR16 FormatString,
  ... 
)

Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Unicode format string and variable argument list.

Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer and BufferSize. The ASCII string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list based on the contents of the format string. The number of ASCII characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0, then no output buffer is produced and 0 is returned.

If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 0 and FormatString is NULL, then ASSERT(). If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated Unicode format string.
... Variable argument list whose contents are accessed based on the format string specified by FormatString.
Returns:
The number of ASCII characters in the produced output buffer not including the Null-terminator.

References AsciiVSPrintUnicodeFormat(), VA_END, and VA_START.

UINTN EFIAPI AsciiValueToString ( OUT CHAR8 Buffer,
IN UINTN  Flags,
IN INT64  Value,
IN UINTN  Width 
)

Converts a decimal value to a Null-terminated ASCII string.

Converts the decimal number specified by Value to a Null-terminated ASCII string specified by Buffer containing at most Width characters. No padding of spaces is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed. The number of ASCII characters in Buffer is returned not including the Null-terminator. If the conversion contains more than Width characters, then only the first Width characters are returned, and the total number of characters required to perform the conversion is returned. Additional conversion parameters are specified in Flags. The Flags bit LEFT_JUSTIFY is always ignored. All conversions are left justified in Buffer. If Width is 0, PREFIX_ZERO is ignored in Flags. If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas are inserted every 3rd digit starting from the right. If RADIX_HEX is set in Flags, then the output buffer will be formatted in hexadecimal format. If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'. If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then Buffer is padded with '0' characters so the combination of the optional '-' sign character, '0' characters, digit characters for Value, and the Null-terminator add up to Width characters.

If Buffer is NULL, then ASSERT(). If unsupported bits are set in Flags, then ASSERT(). If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT(). If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

Parameters:
Buffer The pointer to the output buffer for the produced Null-terminated ASCII string.
Flags The bitmask of flags that specify left justification, zero pad, and commas.
Value The 64-bit signed value to convert to a string.
Width The maximum number of ASCII characters to place in Buffer, not including the Null-terminator.
Returns:
The number of ASCII characters in Buffer not including the Null-terminator.

References BasePrintLibConvertValueToString().

UINTN EFIAPI AsciiVSPrint ( OUT CHAR8 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR8 FormatString,
IN VA_LIST  Marker 
)

Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated ASCII format string and a VA_LIST argument list.

Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer and BufferSize. The ASCII string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list specified by Marker based on the contents of the format string. The number of ASCII characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0, then no output buffer is produced and 0 is returned.

If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 0 and FormatString is NULL, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated ASCII format string.
Marker VA_LIST marker for the variable argument list.
Returns:
The number of ASCII characters in the produced output buffer not including the Null-terminator.

References BasePrintLibSPrintMarker(), and NULL.

Referenced by AsciiSPrint(), and DebugPrint().

UINTN EFIAPI AsciiVSPrintUnicodeFormat ( OUT CHAR8 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR16 FormatString,
IN VA_LIST  Marker 
)

Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Unicode format string and a VA_LIST argument list.

Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer and BufferSize. The ASCII string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list specified by Marker based on the contents of the format string. The number of ASCII characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0, then no output buffer is produced and 0 is returned.

If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 0 and FormatString is NULL, then ASSERT(). If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated Unicode format string.
Marker VA_LIST marker for the variable argument list.
Returns:
The number of ASCII characters in the produced output buffer not including the Null-terminator.

References ASSERT_UNICODE_BUFFER, BasePrintLibSPrintMarker(), FORMAT_UNICODE, and NULL.

Referenced by AsciiSPrintUnicodeFormat().

UINTN EFIAPI SPrintLength ( IN CONST CHAR16 FormatString,
IN VA_LIST  Marker 
)

Returns the number of characters that would be produced by if the formatted output were produced not including the Null-terminator.

If FormatString is NULL, then ASSERT(). If FormatString is not aligned on a 16-bit boundary, then ASSERT().

Parameters:
[in] FormatString A Null-terminated Unicode format string.
[in] Marker VA_LIST marker for the variable argument list.
Returns:
The number of characters that would be produced, not including the Null-terminator.

References ASSERT, ASSERT_UNICODE_BUFFER, BasePrintLibSPrintMarker(), COUNT_ONLY_NO_PRINT, FORMAT_UNICODE, NULL, and OUTPUT_UNICODE.

Referenced by CatVSPrint(), and UefiDevicePathLibCatPrint().

UINTN EFIAPI SPrintLengthAsciiFormat ( IN CONST CHAR8 FormatString,
IN VA_LIST  Marker 
)

Returns the number of characters that would be produced by if the formatted output were produced not including the Null-terminator.

If FormatString is NULL, then ASSERT().

Parameters:
[in] FormatString A Null-terminated ASCII format string.
[in] Marker VA_LIST marker for the variable argument list.
Returns:
The number of characters that would be produced, not including the Null-terminator.

References ASSERT, BasePrintLibSPrintMarker(), COUNT_ONLY_NO_PRINT, NULL, and OUTPUT_UNICODE.

UINTN EFIAPI UnicodeBSPrint ( OUT CHAR16 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR16 FormatString,
IN BASE_LIST  Marker 
)

Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated Unicode format string and a BASE_LIST argument list

Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer and BufferSize. The Unicode string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list specified by Marker based on the contents of the format string. The number of Unicode characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). If BufferSize > 1 and FormatString is NULL, then ASSERT(). If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated Unicode format string.
Marker BASE_LIST marker for the variable argument list.
Returns:
The number of Unicode characters in the produced output buffer not including the Null-terminator.

References ASSERT_UNICODE_BUFFER, BasePrintLibSPrintMarker(), FORMAT_UNICODE, gNullVaList, and OUTPUT_UNICODE.

UINTN EFIAPI UnicodeBSPrintAsciiFormat ( OUT CHAR16 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR8 FormatString,
IN BASE_LIST  Marker 
)

Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated ASCII format string and a BASE_LIST argument list

Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer and BufferSize. The Unicode string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list specified by Marker based on the contents of the format string. The number of Unicode characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). If BufferSize > 1 and FormatString is NULL, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated ASCII format string.
Marker BASE_LIST marker for the variable argument list.
Returns:
The number of Unicode characters in the produced output buffer not including the Null-terminator.

References ASSERT_UNICODE_BUFFER, BasePrintLibSPrintMarker(), gNullVaList, and OUTPUT_UNICODE.

UINTN EFIAPI UnicodeSPrint ( OUT CHAR16 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR16 FormatString,
  ... 
)

Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated Unicode format string and variable argument list.

Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer and BufferSize. The Unicode string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list based on the contents of the format string. The number of Unicode characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). If BufferSize > 1 and FormatString is NULL, then ASSERT(). If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated Unicode format string.
... Variable argument list whose contents are accessed based on the format string specified by FormatString.
Returns:
The number of Unicode characters in the produced output buffer not including the Null-terminator.

References UnicodeVSPrint(), VA_END, and VA_START.

Referenced by DevPathToTextAcpiEx().

UINTN EFIAPI UnicodeSPrintAsciiFormat ( OUT CHAR16 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR8 FormatString,
  ... 
)

Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated ASCII format string and variable argument list.

Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer and BufferSize. The Unicode string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list based on the contents of the format string. The number of Unicode characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). If BufferSize > 1 and FormatString is NULL, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated ASCII format string.
... Variable argument list whose contents are accessed based on the format string specified by FormatString.
Returns:
The number of Unicode characters in the produced output buffer not including the Null-terminator.

References UnicodeVSPrintAsciiFormat(), VA_END, and VA_START.

Referenced by AsciiPrintXY(), and DebugAssert().

UINTN EFIAPI UnicodeValueToString ( IN OUT CHAR16 Buffer,
IN UINTN  Flags,
IN INT64  Value,
IN UINTN  Width 
)

Converts a decimal value to a Null-terminated Unicode string.

Converts the decimal number specified by Value to a Null-terminated Unicode string specified by Buffer containing at most Width characters. No padding of spaces is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed. The number of Unicode characters in Buffer is returned not including the Null-terminator. If the conversion contains more than Width characters, then only the first Width characters are returned, and the total number of characters required to perform the conversion is returned. Additional conversion parameters are specified in Flags.

The Flags bit LEFT_JUSTIFY is always ignored. All conversions are left justified in Buffer. If Width is 0, PREFIX_ZERO is ignored in Flags. If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas are inserted every 3rd digit starting from the right. If RADIX_HEX is set in Flags, then the output buffer will be formatted in hexadecimal format. If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'. If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, then Buffer is padded with '0' characters so the combination of the optional '-' sign character, '0' characters, digit characters for Value, and the Null-terminator add up to Width characters. If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT(). If Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 16-bit boundary, then ASSERT(). If unsupported bits are set in Flags, then ASSERT(). If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT(). If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

Parameters:
Buffer The pointer to the output buffer for the produced Null-terminated Unicode string.
Flags The bitmask of flags that specify left justification, zero pad, and commas.
Value The 64-bit signed value to convert to a string.
Width The maximum number of Unicode characters to place in Buffer, not including the Null-terminator.
Returns:
The number of Unicode characters in Buffer not including the Null-terminator.

References ASSERT_UNICODE_BUFFER, and BasePrintLibConvertValueToString().

UINTN EFIAPI UnicodeVSPrint ( OUT CHAR16 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR16 FormatString,
IN VA_LIST  Marker 
)

Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated Unicode format string and a VA_LIST argument list

Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer and BufferSize. The Unicode string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list specified by Marker based on the contents of the format string. The number of Unicode characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). If BufferSize > 1 and FormatString is NULL, then ASSERT(). If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated Unicode format string.
Marker VA_LIST marker for the variable argument list.
Returns:
The number of Unicode characters in the produced output buffer not including the Null-terminator.

References ASSERT_UNICODE_BUFFER, BasePrintLibSPrintMarker(), FORMAT_UNICODE, NULL, and OUTPUT_UNICODE.

Referenced by CatVSPrint(), FileHandlePrintLine(), InternalPrint(), PrintXY(), UefiDevicePathLibCatPrint(), and UnicodeSPrint().

UINTN EFIAPI UnicodeVSPrintAsciiFormat ( OUT CHAR16 StartOfBuffer,
IN UINTN  BufferSize,
IN CONST CHAR8 FormatString,
IN VA_LIST  Marker 
)

Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated ASCII format string and a VA_LIST argument list

Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer and BufferSize. The Unicode string is produced by parsing the format string specified by FormatString. Arguments are pulled from the variable argument list specified by Marker based on the contents of the format string. The number of Unicode characters in the produced output buffer is returned not including the Null-terminator. If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). If BufferSize > 1 and FormatString is NULL, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StartOfBuffer A pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
FormatString A Null-terminated ASCII format string.
Marker VA_LIST marker for the variable argument list.
Returns:
The number of Unicode characters in the produced output buffer not including the Null-terminator.

References ASSERT_UNICODE_BUFFER, BasePrintLibSPrintMarker(), NULL, and OUTPUT_UNICODE.

Referenced by AsciiInternalPrint(), DebugPrint(), and UnicodeSPrintAsciiFormat().


Variable Documentation


Generated on Thu Sep 24 23:14:23 2015 for MdePkg[ALL] by  doxygen 1.5.7.1