tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MdeModulePkg: Refine the services comments in EFI_PRINT2_PROTOCOL 

For the following 8 services in EFI_PRINT2_PROTOCOL:
UNICODE_BS_PRINT
UNICODE_S_PRINT
UNICODE_BS_PRINT_ASCII_FORMAT
UNICODE_S_PRINT_ASCII_FORMAT
ASCII_BS_PRINT
ASCII_S_PRINT
ASCII_BS_PRINT_UNICODE_FORMAT
ASCII_S_PRINT_UNICODE_FORMAT

They will ASSERT when:
1) The input parameter 'StartOfBuffer' is NULL if 'BufferSize' indicates
at least 1 Ascii/Unicode character can be held.
2) The input parameter 'FormatString' is NULL if 'BufferSize' indicates at
least 1 Ascii/Unicode character can be held.
3) The input parameter 'FormatString' contains more than
PcdMaximum[Ascii|Unicode]StringLength Ascii/Unicode characters.
4) The produced string contains more than
PcdMaximum[Ascii|Unicode]StringLength Ascii/Unicode characters.

This commits removes the ASSERT case 4) and add the following new ASSERT
case:
4) The input parameter 'BufferSize' is greater than
(PcdMaximumAsciiStringLength * sizeof (CHAR8)) for Ascii format string or
(PcdMaximumUnicodeStringLength * sizeof (CHAR16) + 1) for Unicode format
string.

And for those ASSERT cases, 0 will be returned by those services.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Hao Wu 2017-02-08 10:48:14 +08:00
parent 50418baa69
commit 0b6642e60e
1 changed files with 208 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

367
MdeModulePkg/Include/Protocol/Print2.h
View File

@ -3,7 +3,7 @@
This print protocol defines six basic print functions to This print protocol defines six basic print functions to
print the format unicode and ascii string. print the format unicode and ascii string.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution. the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at The full text of the license may be found at
@ -26,35 +26,40 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL; typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL;
/** /**
Produces a Null-terminated Unicode string in an output buffer, based on Produces a Null-terminated Unicode string in an output buffer based on
a Null-terminated Unicode format string and a BASE_LIST argument list 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.
Marker is constructed based on the contents of the format string.
This function returns the number of Unicode characters in the produced output buffer,
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(). Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). and BufferSize.
If BufferSize > 1 and FormatString is NULL, then ASSERT(). The Unicode string is produced by parsing the format string specified by FormatString.
If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT(). Arguments are pulled from the variable argument list specified by Marker based on the
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than contents of the format string.
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT(). The number of Unicode characters in the produced output buffer is returned not including
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string the Null-terminator.
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT().
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated 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.
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string. Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string. @param FormatString A Null-terminated Unicode format string.
@param Marker BASE_LIST marker for the variable argument list. @param Marker BASE_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced output buffer, not including the @return The number of Unicode characters in the produced output buffer not including the
Null-terminator. Null-terminator.
**/ **/
@ -68,34 +73,41 @@ UINTN
); );
/** /**
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
Unicode format string and variable argument list. Unicode format string and variable argument list.
Produces a Null-terminated Unicode string in the output buffer This function is similar as snprintf_s defined in C11.
specified by StartOfBuffer and BufferSize.
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. 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. Arguments are pulled from the variable argument list based on the contents of the format string.
This function returns the number of Unicode characters in the produced output buffer, The number of Unicode characters in the produced output buffer is returned not including
not including the Null-terminator. 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 StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().
If BufferSize > 1 and 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 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().
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated 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.
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string. Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string. @param FormatString A Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based on the @param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString. format string specified by FormatString.
@return The number of Unicode characters in the produced output buffer not including the @return The number of Unicode characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -110,33 +122,38 @@ UINTN
); );
/** /**
Produces a Null-terminated Unicode string in an output buffer, based on a Null-terminated Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
ASCII format string and a BASE_LIST argument list ASCII format string and a BASE_LIST argument list.
Produces a Null-terminated Unicode string in the output buffer Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
specified by StartOfBuffer and BufferSize. and BufferSize.
The Unicode string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list specified by Marker based on the
contents of the format string. contents of the format string.
This function returns the number of Unicode characters in the produced output buffer, The number of Unicode characters in the produced output buffer is returned not including
not including the Null-terminator. 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. 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(). @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
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().
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string. Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated ASCII format string. @param FormatString A Null-terminated ASCII format string.
@param Marker BASE_LIST marker for the variable argument list. @param Marker BASE_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced output buffer not including the @return The number of Unicode characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -151,33 +168,41 @@ UINTN
); );
/** /**
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
ASCII format string and a variable argument list. ASCII format string and variable argument list.
Produces a Null-terminated Unicode string in the output buffer This function is similar as snprintf_s defined in C11.
specified by StartOfBuffer and BufferSize.
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. 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. Arguments are pulled from the variable argument list based on the contents of the
This function returns the number of Unicode characters in the produced output buffer, format string.
not including the Null-terminator. 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. 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(). @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
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().
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string. Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated ASCII format string. @param FormatString A Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based on the @param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString. format string specified by FormatString.
@return The number of Unicode characters in the produced output buffer not including the @return The number of Unicode characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -244,30 +269,34 @@ UINTN
/** /**
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
ASCII format string and a BASE_LIST argument list. ASCII format string and a BASE_LIST argument list.
Produces a Null-terminated ASCII string in the output buffer Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
pecified by StartOfBuffer and BufferSize. and BufferSize.
The ASCII string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list specified by Marker based on
the contents of the format string. the contents of the format string.
This function returns the number of ASCII characters in the output buffer, The number of ASCII characters in the produced output buffer is returned not including
not including the Null-terminator. 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. If BufferSize is 0, then no output buffer is produced and 0 is returned.
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
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().
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string. ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated ASCII format string. @param FormatString A Null-terminated ASCII format string.
@param Marker BASE_LIST marker for the variable argument list. @param Marker BASE_LIST marker for the variable argument list.
@return The number of ASCII characters in the produced output buffer not including the @return The number of ASCII characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -283,31 +312,38 @@ UINTN
/** /**
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
ASCII format string and variable argument list. ASCII format string and variable argument list.
Produces a Null-terminated ASCII string in the output buffer This function is similar as snprintf_s defined in C11.
specified by StartOfBuffer and BufferSize.
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. 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. Arguments are pulled from the variable argument list based on the contents of the
This function returns the number of ASCII characters in the output buffer, format string.
not including the Null-terminator. 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. If BufferSize is 0, then no output buffer is produced and 0 is returned.
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
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().
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string. ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated ASCII format string. @param FormatString A Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based on the @param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString. format string specified by FormatString.
@return The number of ASCII characters in the produced output buffer not including the @return The number of ASCII characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -324,31 +360,36 @@ UINTN
/** /**
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
Unicode format string and a BASE_LIST argument list. Unicode format string and a BASE_LIST argument list.
Produces a Null-terminated ASCII string in the output buffer Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
specified by StartOfBuffer and BufferSize. and BufferSize.
The ASCII string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list specified by Marker based on
the contents of the format string. the contents of the format string.
This function returns the number of ASCII characters in the output buffer, The number of ASCII characters in the produced output buffer is returned not including
not including the Null-terminator. 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. If BufferSize is 0, then no output buffer is produced and 0 is returned.
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
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().
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string. ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string. @param FormatString A Null-terminated Unicode format string.
@param Marker BASE_LIST marker for the variable argument list. @param Marker BASE_LIST marker for the variable argument list.
@return The number of ASCII characters in the produced output buffer not including the @return The number of ASCII characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -365,31 +406,39 @@ UINTN
/** /**
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
Unicode format string and variable argument list. Unicode format string and variable argument list.
Produces a Null-terminated ASCII string in the output buffer This function is similar as snprintf_s defined in C11.
specified by StartOfBuffer and BufferSize.
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. 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. Arguments are pulled from the variable argument list based on the contents of the
This function returns the number of ASCII characters in the output buffer, format string.
not including the Null-terminator. 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. If BufferSize is 0, then no output buffer is produced and 0 is returned.
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
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().
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string. ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string. @param FormatString A Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based on the @param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString. format string specified by FormatString.
@return The number of ASCII characters in the produced output buffer not including the @return The number of ASCII characters in the produced output buffer not including the
Null-terminator. Null-terminator.