Grammatical and disclaimer changes (does not follow internal C coding stds.)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10235 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -2,11 +2,11 @@
|
||||
Provides services to print a formatted string to a buffer. All combinations of
|
||||
Unicode and ASCII strings are supported.
|
||||
|
||||
Copyright (c) 2006 - 2009, Intel Corporation
|
||||
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
|
||||
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
|
||||
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 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.
|
||||
@@ -177,8 +177,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
///
|
||||
/// Define the maximum number of characters that are required to
|
||||
/// encode a decimal, hexadecimal, GUID, or TIME value with a NULL
|
||||
/// terminator.
|
||||
/// encode with a NULL terminator a decimal, hexadecimal, GUID,
|
||||
/// or TIME value.
|
||||
///
|
||||
/// Maximum Length Decimal String = 28
|
||||
/// "-9,223,372,036,854,775,808"
|
||||
@@ -202,14 +202,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
/**
|
||||
Produces a Null-terminated Unicode string in an output buffer based on
|
||||
a Null-terminated Unicode format string and a VA_LIST argument list
|
||||
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 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.
|
||||
|
||||
@@ -218,10 +218,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
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
|
||||
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
|
||||
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
|
||||
@@ -230,7 +230,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
@param FormatString Null-terminated Unicode format string.
|
||||
@param Marker VA_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.
|
||||
|
||||
**/
|
||||
@@ -245,14 +245,14 @@ UnicodeVSPrint (
|
||||
|
||||
/**
|
||||
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 based on the
|
||||
contents of the format string.
|
||||
The number of Unicode characters in the produced output buffer is returned not including
|
||||
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.
|
||||
|
||||
@@ -261,10 +261,10 @@ UnicodeVSPrint (
|
||||
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
|
||||
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
|
||||
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
|
||||
@@ -273,7 +273,7 @@ UnicodeVSPrint (
|
||||
@param FormatString Null-terminated Unicode format string.
|
||||
@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.
|
||||
|
||||
**/
|
||||
@@ -294,7 +294,7 @@ UnicodeBSPrint (
|
||||
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 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.
|
||||
|
||||
@@ -312,11 +312,11 @@ UnicodeBSPrint (
|
||||
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
|
||||
Unicode string.
|
||||
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||||
@param FormatString Null-terminated Unicode format string.
|
||||
@param ... Variable argument list whose contents are accessed based on the
|
||||
@param FormatString A null-terminated Unicode format string.
|
||||
@param ... The variable argument list whose contents are accessed based on the
|
||||
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.
|
||||
|
||||
**/
|
||||
@@ -338,7 +338,7 @@ UnicodeSPrint (
|
||||
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 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.
|
||||
|
||||
@@ -346,16 +346,16 @@ UnicodeSPrint (
|
||||
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
|
||||
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
|
||||
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.
|
||||
@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 VA_LIST marker for the variable argument list.
|
||||
|
||||
@return The number of Unicode characters in the produced output buffer not including the
|
||||
@@ -380,7 +380,7 @@ UnicodeVSPrintAsciiFormat (
|
||||
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 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.
|
||||
|
||||
@@ -388,19 +388,19 @@ UnicodeVSPrintAsciiFormat (
|
||||
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
|
||||
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
|
||||
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.
|
||||
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||||
@param FormatString Null-terminated ASCII format string.
|
||||
@param Marker BASE_LIST marker for the variable argument list.
|
||||
@param FormatString A null-terminated ASCII format string.
|
||||
@param Marker A 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.
|
||||
|
||||
**/
|
||||
@@ -422,7 +422,7 @@ UnicodeBSPrintAsciiFormat (
|
||||
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 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.
|
||||
|
||||
@@ -430,20 +430,20 @@ UnicodeBSPrintAsciiFormat (
|
||||
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
|
||||
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
|
||||
contains more than PcdMaximumUnicodeStringLength Unicode characters, the
|
||||
Null-terminator, then ASSERT().
|
||||
|
||||
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
|
||||
Unicode string.
|
||||
@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
|
||||
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.
|
||||
|
||||
**/
|
||||
@@ -462,7 +462,7 @@ UnicodeSPrintAsciiFormat (
|
||||
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.
|
||||
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.
|
||||
@@ -487,14 +487,14 @@ UnicodeSPrintAsciiFormat (
|
||||
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
|
||||
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
|
||||
|
||||
@param Buffer Pointer to the output buffer for the produced Null-terminated
|
||||
@param Buffer The pointer to the output buffer for the produced Null-terminated
|
||||
Unicode string.
|
||||
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
|
||||
@param Value The 64-bit signed value to convert to a string.
|
||||
@param Width The maximum number of Unicode characters to place in Buffer, not including
|
||||
the Null-terminator.
|
||||
|
||||
@return The number of Unicode characters in Buffer not including the Null-terminator.
|
||||
@return The number of Unicode characters in Buffer, not including the Null-terminator.
|
||||
|
||||
**/
|
||||
UINTN
|
||||
@@ -515,26 +515,26 @@ UnicodeValueToString (
|
||||
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 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
|
||||
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
|
||||
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.
|
||||
@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 VA_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.
|
||||
|
||||
**/
|
||||
@@ -556,26 +556,26 @@ AsciiVSPrint (
|
||||
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 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
|
||||
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
|
||||
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.
|
||||
@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.
|
||||
|
||||
@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.
|
||||
|
||||
**/
|
||||
@@ -597,27 +597,27 @@ AsciiBSPrint (
|
||||
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 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
|
||||
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
|
||||
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.
|
||||
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
|
||||
@param FormatString Null-terminated ASCII format string.
|
||||
@param ... Variable argument list whose contents are accessed based on the
|
||||
@param FormatString A null-terminated ASCII format string.
|
||||
@param ... The variable argument list whose contents are accessed based on the
|
||||
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.
|
||||
|
||||
**/
|
||||
@@ -639,7 +639,7 @@ AsciiSPrint (
|
||||
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 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.
|
||||
|
||||
@@ -647,19 +647,19 @@ AsciiSPrint (
|
||||
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
|
||||
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
|
||||
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.
|
||||
@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 VA_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.
|
||||
|
||||
**/
|
||||
@@ -681,7 +681,7 @@ AsciiVSPrintUnicodeFormat (
|
||||
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 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.
|
||||
|
||||
@@ -689,19 +689,19 @@ AsciiVSPrintUnicodeFormat (
|
||||
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
|
||||
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
|
||||
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.
|
||||
@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.
|
||||
|
||||
@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.
|
||||
|
||||
**/
|
||||
@@ -723,7 +723,7 @@ AsciiBSPrintUnicodeFormat (
|
||||
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 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.
|
||||
|
||||
@@ -731,20 +731,20 @@ AsciiBSPrintUnicodeFormat (
|
||||
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
|
||||
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
|
||||
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.
|
||||
@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
|
||||
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.
|
||||
|
||||
**/
|
||||
@@ -764,7 +764,7 @@ AsciiSPrintUnicodeFormat (
|
||||
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.
|
||||
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.
|
||||
@@ -787,14 +787,14 @@ AsciiSPrintUnicodeFormat (
|
||||
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
|
||||
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
|
||||
|
||||
@param Buffer Pointer to the output buffer for the produced Null-terminated
|
||||
@param Buffer A pointer to the output buffer for the produced Null-terminated
|
||||
ASCII string.
|
||||
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
|
||||
@param Value The 64-bit signed value to convert to a string.
|
||||
@param Width The maximum number of ASCII characters to place in Buffer, not including
|
||||
the Null-terminator.
|
||||
|
||||
@return The number of ASCII characters in Buffer not including the Null-terminator.
|
||||
@return The number of ASCII characters in Buffer, not including the Null-terminator.
|
||||
|
||||
**/
|
||||
UINTN
|
||||
|
Reference in New Issue
Block a user