TianoCore EDK2 master
Loading...
Searching...
No Matches
Macros | Functions
PrintLib.h File Reference

Go to the source code of this file.

Macros

#define MAXIMUM_VALUE_CHARACTERS   38
 
#define LEFT_JUSTIFY   0x01
 
#define COMMA_TYPE   0x08
 
#define PREFIX_ZERO   0x20
 
#define RADIX_HEX   0x80
 

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,...)
 
RETURN_STATUS EFIAPI UnicodeValueToStringS (IN OUT CHAR16 *Buffer, IN UINTN BufferSize, 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,...)
 
RETURN_STATUS EFIAPI AsciiValueToStringS (IN OUT CHAR8 *Buffer, IN UINTN BufferSize, 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)
 

Detailed Description

Provides services to print a formatted string to a buffer. All combinations of Unicode and ASCII strings are supported.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

The Print Library functions provide a simple means to produce formatted output strings. Many of the output functions use a format string to describe how to format the output of variable arguments. The format string consists of normal text and argument descriptors. There are no restrictions for how the normal text and argument descriptors can be mixed. The following end of line(EOL) translations must be performed on the contents of the format string:

  • '\r' is translated to '\r'
  • '\r\n' is translated to '\r\n'
  • '\n' is translated to '\r\n'
  • '\n\r' is translated to '\r\n'

This does not follow the ANSI C standard for sprint(). The format of argument descriptors is described below. The ANSI C standard for sprint() has been followed for some of the format types, and has not been followed for others. The exceptions are noted below.

%[flags][width][.precision]type

[flags]:

  • -
    • The field is left justified. If not flag is not specified, then the field is right justified.
  • space
    • Prefix a space character to a number. Only valid for types X, x, and d.
  • +
    • Prefix a plus character to a number. Only valid for types X, x, and d. If both space and + are specified, then space is ignored.
  • 0
    • Pad with 0 characters to the left of a number. Only valid for types X, x, and d.
  • ,
    • Place a comma every 3rd digit of the number. Only valid for type d. If 0 is also specified, then 0 is ignored.
  • L, l
    • The number being printed is size UINT64. Only valid for types X, x, and d. If this flag is not specified, then the number being printed is size int.
  • NOTE: All invalid flags are ignored.

[width]:

  • *
    • The width of the field is specified by a UINTN argument in the argument list.
  • number
    • The number specified as a decimal value represents the width of the field.
  • NOTE: If [width] is not specified, then a field width of 0 is assumed.

[.precision]:

  • *
    • The precision of the field is specified by a UINTN argument in the argument list.
  • number
    • The number specified as a decimal value represents the precision of the field.
  • NOTE: If [.precision] is not specified, then a precision of 0 is assumed.

type:

  • %
    • Print a %%.
  • c
    • The argument is a Unicode character. ASCII characters can be printed using this type too by making sure bits 8..15 of the argument are set to 0.
  • x
    • The argument is an unsigned hexadecimal number. The characters used are 0..9 and A..F. If the flag 'L' is not specified, then the argument is assumed to be size int. This does not follow ANSI C.
  • X
    • The argument is an unsigned hexadecimal number and the number is padded with zeros. This is equivalent to a format string of "0x". If the flag 'L' is not specified, then the argument is assumed to be size int. This does not follow ANSI C.
  • d
    • The argument is a signed decimal number. If the flag 'L' is not specified, then the argument is assumed to be size int.
  • u
    • The argument is a unsigned decimal number. If the flag 'L' is not specified, then the argument is assumed to be size int.
  • p
    • The argument is a pointer that is a (VOID *), and it is printed as an unsigned hexadecimal number The characters used are 0..9 and A..F.
  • a
    • The argument is a pointer to an ASCII string. This does not follow ANSI C.
  • S, s
    • The argument is a pointer to a Unicode string. This does not follow ANSI C.
  • g
    • The argument is a pointer to a GUID structure. The GUID is printed in the format XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. This does not follow ANSI C.
  • t
    • The argument is a pointer to an EFI_TIME structure. The time and date are printed in the format "mm/dd/yyyy hh:mm" where mm is the month zero padded, dd is the day zero padded, yyyy is the year zero padded, hh is the hour zero padded, and mm is minutes zero padded. This does not follow ANSI C.
  • r
    • The argument is a RETURN_STATUS value. This value is converted to a string following the table below. This does not follow ANSI C.
    • RETURN_SUCCESS
      • "Success"
    • RETURN_LOAD_ERROR
      • "Load Error"
    • RETURN_INVALID_PARAMETER
      • "Invalid Parameter"
    • RETURN_UNSUPPORTED
      • "Unsupported"
    • RETURN_BAD_BUFFER_SIZE
      • "Bad Buffer Size"
    • RETURN_BUFFER_TOO_SMALL
      • "Buffer Too Small"
    • RETURN_NOT_READY
      • "Not Ready"
    • RETURN_DEVICE_ERROR
      • "Device Error"
    • RETURN_WRITE_PROTECTED
      • "Write Protected"
    • RETURN_OUT_OF_RESOURCES
      • "Out of Resources"
    • RETURN_VOLUME_CORRUPTED
      • "Volume Corrupt"
    • RETURN_VOLUME_FULL
      • "Volume Full"
    • RETURN_NO_MEDIA
      • "No Media"
    • RETURN_MEDIA_CHANGED
      • "Media changed"
    • RETURN_NOT_FOUND
      • "Not Found"
    • RETURN_ACCESS_DENIED
      • "Access Denied"
    • RETURN_NO_RESPONSE
      • "No Response"
    • RETURN_NO_MAPPING
      • "No mapping"
    • RETURN_TIMEOUT
      • "Time out"
    • RETURN_NOT_STARTED
      • "Not started"
    • RETURN_ALREADY_STARTED
      • "Already started"
    • RETURN_ABORTED
      • "Aborted"
    • RETURN_ICMP_ERROR
      • "ICMP Error"
    • RETURN_TFTP_ERROR
      • "TFTP Error"
    • RETURN_PROTOCOL_ERROR
      • "Protocol Error"
    • RETURN_WARN_UNKNOWN_GLYPH
      • "Warning Unknown Glyph"
    • RETURN_WARN_DELETE_FAILURE
      • "Warning Delete Failure"
    • RETURN_WARN_WRITE_FAILURE
      • "Warning Write Failure"
    • RETURN_WARN_BUFFER_TOO_SMALL
      • "Warning Buffer Too Small"

Definition in file PrintLib.h.

Macro Definition Documentation

◆ COMMA_TYPE

#define COMMA_TYPE   0x08

Definition at line 196 of file PrintLib.h.

◆ LEFT_JUSTIFY

#define LEFT_JUSTIFY   0x01

Flags bitmask values use in UnicodeValueToString() and AsciiValueToString()

Definition at line 195 of file PrintLib.h.

◆ MAXIMUM_VALUE_CHARACTERS

#define MAXIMUM_VALUE_CHARACTERS   38

Define the maximum number of characters that are required to encode with a NULL terminator a decimal, hexadecimal, GUID, or TIME value.

Maximum Length Decimal String = 28 "-9,223,372,036,854,775,808" Maximum Length Hexadecimal String = 17 "FFFFFFFFFFFFFFFF" Maximum Length GUID = 37 "00000000-0000-0000-0000-000000000000" Maximum Length TIME = 18 "12/12/2006 12:12"

Definition at line 189 of file PrintLib.h.

◆ PREFIX_ZERO

#define PREFIX_ZERO   0x20

Definition at line 197 of file PrintLib.h.

◆ RADIX_HEX

#define RADIX_HEX   0x80

Definition at line 198 of file PrintLib.h.

Function Documentation

◆ AsciiBSPrint()

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 > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and BufferSize > (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0, then no output buffer is produced and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA Null-terminated ASCII format string.
MarkerBASE_LIST marker for the variable argument list.
Returns
The number of ASCII characters in the produced output buffer not including the Null-terminator.

Definition at line 763 of file PrintLib.c.

◆ AsciiBSPrintUnicodeFormat()

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 FormatString is not aligned on a 16-bit boundary, then ASSERT().

If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and BufferSize > (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0, then no output buffer is produced and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA Null-terminated Unicode format string.
MarkerBASE_LIST marker for the variable argument list.
Returns
The number of ASCII characters in the produced output buffer not including the Null-terminator.

Definition at line 935 of file PrintLib.c.

◆ AsciiSPrint()

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.

This function is similar as snprintf_s defined in C11.

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 > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and BufferSize > (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0, then no output buffer is produced and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA 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.

Definition at line 813 of file PrintLib.c.

◆ AsciiSPrintUnicodeFormat()

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.

This function is similar as snprintf_s defined in C11.

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 FormatString is not aligned on a 16-bit boundary, then ASSERT().

If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and BufferSize > (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0, then no output buffer is produced and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA 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.

Definition at line 988 of file PrintLib.c.

◆ AsciiValueToStringS()

RETURN_STATUS EFIAPI AsciiValueToStringS ( IN OUT CHAR8 *  Buffer,
IN UINTN  BufferSize,
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. If the conversion contains more than Width characters, then only the first Width characters are placed in Buffer. 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 an error would be returned, then the function will ASSERT().

Parameters
BufferThe pointer to the output buffer for the produced Null-terminated Ascii string.
BufferSizeThe size of Buffer in bytes, including the Null-terminator.
FlagsThe bitmask of flags that specify left justification, zero pad, and commas.
ValueThe 64-bit signed value to convert to a string.
WidthThe maximum number of Ascii characters to place in Buffer, not including the Null-terminator.
Return values
RETURN_SUCCESSThe decimal value is converted.
RETURN_BUFFER_TOO_SMALLIf BufferSize cannot hold the converted value.
RETURN_INVALID_PARAMETERIf Buffer is NULL. If PcdMaximumAsciiStringLength is not zero, and BufferSize is greater than PcdMaximumAsciiStringLength. If unsupported bits are set in Flags. If both COMMA_TYPE and RADIX_HEX are set in Flags. If Width >= MAXIMUM_VALUE_CHARACTERS.

Definition at line 1055 of file PrintLib.c.

◆ AsciiVSPrint()

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.

This function is similar as vsnprintf_s defined in C11.

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 > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and BufferSize > (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0, then no output buffer is produced and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA Null-terminated ASCII format string.
MarkerVA_LIST marker for the variable argument list.
Returns
The number of ASCII characters in the produced output buffer not including the Null-terminator.

Definition at line 702 of file PrintLib.c.

◆ AsciiVSPrintUnicodeFormat()

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.

This function is similar as vsnprintf_s defined in C11.

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 FormatString is not aligned on a 16-bit boundary, then ASSERT().

If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 0 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and BufferSize > (PcdMaximumAsciiStringLength * sizeof (CHAR8)), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0, then no output buffer is produced and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated ASCII string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA Null-terminated Unicode format string.
MarkerVA_LIST marker for the variable argument list.
Returns
The number of ASCII characters in the produced output buffer not including the Null-terminator.

Definition at line 870 of file PrintLib.c.

◆ SPrintLength()

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 not aligned on a 16-bit boundary, then ASSERT().

If FormatString is NULL, then ASSERT() and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT() and 0 is returned.

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

Definition at line 2091 of file PrintLib.c.

◆ SPrintLengthAsciiFormat()

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() and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then ASSERT() and 0 is returned.

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

Definition at line 2117 of file PrintLib.c.

◆ UnicodeBSPrint()

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 StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). If FormatString is not aligned on a 16-bit boundary, then ASSERT().

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and BufferSize > (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA Null-terminated Unicode format string.
MarkerBASE_LIST marker for the variable argument list.
Returns
The number of Unicode characters in the produced output buffer not including the Null-terminator.

Definition at line 354 of file PrintLib.c.

◆ UnicodeBSPrintAsciiFormat()

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 StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and BufferSize > (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA Null-terminated ASCII format string.
MarkerBASE_LIST marker for the variable argument list.
Returns
The number of Unicode characters in the produced output buffer not including the Null-terminator.

Definition at line 530 of file PrintLib.c.

◆ UnicodeSPrint()

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.

This function is similar as snprintf_s defined in C11.

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 StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). If FormatString is not aligned on a 16-bit boundary, then ASSERT().

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and BufferSize > (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA 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.

Definition at line 408 of file PrintLib.c.

◆ UnicodeSPrintAsciiFormat()

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.

This function is similar as snprintf_s defined in C11.

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 StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and BufferSize > (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA 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.

Definition at line 583 of file PrintLib.c.

◆ UnicodeValueToStringS()

RETURN_STATUS EFIAPI UnicodeValueToStringS ( IN OUT CHAR16 *  Buffer,
IN UINTN  BufferSize,
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. If the conversion contains more than Width characters, then only the first Width characters are placed in Buffer. 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 not aligned on a 16-bit boundary, then ASSERT(). If an error would be returned, then the function will also ASSERT().

Parameters
BufferThe pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSizeThe size of Buffer in bytes, including the Null-terminator.
FlagsThe bitmask of flags that specify left justification, zero pad, and commas.
ValueThe 64-bit signed value to convert to a string.
WidthThe maximum number of Unicode characters to place in Buffer, not including the Null-terminator.
Return values
RETURN_SUCCESSThe decimal value is converted.
RETURN_BUFFER_TOO_SMALLIf BufferSize cannot hold the converted value.
RETURN_INVALID_PARAMETERIf Buffer is NULL. If PcdMaximumUnicodeStringLength is not zero, and BufferSize is greater than (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1). If unsupported bits are set in Flags. If both COMMA_TYPE and RADIX_HEX are set in Flags. If Width >= MAXIMUM_VALUE_CHARACTERS.

Definition at line 652 of file PrintLib.c.

◆ UnicodeVSPrint()

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.

This function is similar as vsnprintf_s defined in C11.

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 StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). If FormatString is not aligned on a 16-bit boundary, then ASSERT().

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and BufferSize > (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0 or 1, then the output buffer is unmodified and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA Null-terminated Unicode format string.
MarkerVA_LIST marker for the variable argument list.
Returns
The number of Unicode characters in the produced output buffer not including the Null-terminator.

Definition at line 287 of file PrintLib.c.

◆ UnicodeVSPrintAsciiFormat()

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.

This function is similar as vsnprintf_s defined in C11.

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 StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().

If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If BufferSize > 1 and FormatString is NULL, then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumUnicodeStringLength is not zero, and BufferSize > (PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1), then ASSERT(). Also, the output buffer is unmodified and 0 is returned. If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than PcdMaximumAsciiStringLength Ascii characters not including the Null-terminator, then ASSERT(). Also, the output buffer is unmodified and 0 is returned.

If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.

Parameters
StartOfBufferA pointer to the output buffer for the produced Null-terminated Unicode string.
BufferSizeThe size, in bytes, of the output buffer specified by StartOfBuffer.
FormatStringA Null-terminated ASCII format string.
MarkerVA_LIST marker for the variable argument list.
Returns
The number of Unicode characters in the produced output buffer not including the Null-terminator.

Definition at line 465 of file PrintLib.c.