Mde UEFI library API implementation.\r
Print to StdErr or ConOut defined in EFI_SYSTEM_TABLE\r
\r
- Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
+ http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
If Format is NULL, then ASSERT().\r
If Format is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- @param Format Null-terminated Unicode format string.\r
+ @param Format A Null-terminated Unicode format string.\r
@param Console The output console.\r
- @param Marker VA_LIST marker for the variable argument list.\r
+ @param Marker A VA_LIST marker for the variable argument list.\r
\r
@return The number of Unicode characters in the produced\r
- output buffer not including the Null-terminator.\r
+ output buffer, not including the Null-terminator.\r
**/\r
UINTN\r
InternalPrint (\r
If Format is not aligned on a 16-bit boundary, then ASSERT().\r
If gST->ConOut is NULL, then ASSERT().\r
\r
- @param Format Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based \r
+ @param Format A Null-terminated Unicode format string.\r
+ @param ... A Variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
- @return Number of Unicode characters printed to ConOut.\r
+ @return The number of Unicode characters printed to ConOut.\r
\r
**/\r
UINTN\r
If Format is not aligned on a 16-bit boundary, then ASSERT().\r
If gST->StdErr is NULL, then ASSERT().\r
\r
- @param Format Null-terminated Unicode format string.\r
+ @param Format A Null-terminated Unicode format string.\r
@param ... Variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
- @return Number of Unicode characters printed to StdErr.\r
+ @return The number of Unicode characters printed to StdErr.\r
\r
**/\r
UINTN\r
\r
If Format is NULL, then ASSERT().\r
\r
- @param Format Null-terminated ASCII format string.\r
+ @param Format A Null-terminated ASCII format string.\r
@param Console The output console.\r
@param Marker VA_LIST marker for the variable argument list.\r
\r
If Format is NULL, then ASSERT().\r
If gST->ConOut is NULL, then ASSERT().\r
\r
- @param Format Null-terminated ASCII format string.\r
+ @param Format A Null-terminated ASCII format string.\r
@param ... Variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
- @return Number of ASCII characters printed to ConOut.\r
+ @return The number of ASCII characters printed to ConOut.\r
\r
**/\r
UINTN\r
If Format is NULL, then ASSERT().\r
If gST->StdErr is NULL, then ASSERT().\r
\r
- @param Format Null-terminated ASCII format string.\r
+ @param Format A Null-terminated ASCII format string.\r
@param ... Variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
- @return Number of ASCII characters printed to ConErr.\r
+ @return The number of ASCII characters printed to ConErr.\r
\r
**/\r
UINTN\r
If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no\r
string is printed, and 0 is returned.\r
\r
- @param PointX X coordinate to print the string.\r
- @param PointY Y coordinate to print the string.\r
+ @param PointX An X coordinate to print the string.\r
+ @param PointY A Y coordinate to print the string.\r
@param Foreground The foreground color of the string being printed. This is\r
an optional parameter that may be NULL. If it is NULL,\r
then the foreground color of the current ConOut device\r
an optional parameter that may be NULL. If it is NULL,\r
then the background color of the current ConOut device\r
in the EFI_SYSTEM_TABLE is used.\r
- @param Buffer Null-terminated Unicode formatted string.\r
+ @param Buffer A Null-terminated Unicode formatted string.\r
@param PrintNum The number of Unicode formatted string to be printed.\r
\r
- @return Number of Unicode Characters printed. Zero means no any character\r
+ @return The number of Unicode Characters printed. Zero means no any character\r
displayed successfully.\r
\r
**/\r
If Format is not aligned on a 16-bit boundary, then ASSERT().\r
If gST->ConsoleOutputHandle is NULL, then ASSERT().\r
\r
- @param PointX X coordinate to print the string.\r
- @param PointY Y coordinate to print the string.\r
+ @param PointX An X coordinate to print the string.\r
+ @param PointY A Y coordinate to print the string.\r
@param ForeGround The foreground color of the string being printed. This is\r
an optional parameter that may be NULL. If it is NULL,\r
then the foreground color of the current ConOut device\r
an optional parameter that may be NULL. If it is NULL, \r
then the background color of the current ConOut device\r
in the EFI_SYSTEM_TABLE is used.\r
- @param Format Null-terminated Unicode format string. See Print Library \r
+ @param Format A Null-terminated Unicode format string. See Print Library \r
for the supported format string syntax.\r
- @param ... Variable argument list whose contents are accessed based on \r
+ @param ... A Variable argument list whose contents are accessed based on \r
the format string specified by Format. \r
\r
@return The number of Unicode characters printed.\r
If Format is NULL, then ASSERT().\r
If gST->ConsoleOutputHandle is NULL, then ASSERT().\r
\r
- @param PointX X coordinate to print the string.\r
- @param PointY Y coordinate to print the string.\r
+ @param PointX An X coordinate to print the string.\r
+ @param PointY A Y coordinate to print the string.\r
@param ForeGround The foreground color of the string being printed. This is\r
an optional parameter that may be NULL. If it is NULL,\r
then the foreground color of the current ConOut device\r
an optional parameter that may be NULL. If it is NULL, \r
then the background color of the current ConOut device\r
in the EFI_SYSTEM_TABLE is used.\r
- @param Format Null-terminated ASCII format string. See Print Library \r
+ @param Format A Null-terminated ASCII format string. See Print Library \r
for the supported format string syntax.\r
@param ... Variable argument list whose contents are accessed based on \r
the format string specified by Format. \r
return ReturnNum;\r
}\r
\r
+/** \r
+ Appends a formatted Unicode string to a Null-terminated Unicode string\r
+ \r
+ This function appends a formatted Unicode string to the Null-terminated \r
+ Unicode string specified by String. String is optional and may be NULL.\r
+ Storage for the formatted Unicode string returned is allocated using \r
+ AllocatePool(). The pointer to the appended string is returned. The caller\r
+ is responsible for freeing the returned string.\r
+ \r
+ If String is not NULL and not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is NULL, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+ \r
+ @param[in] String A Null-terminated Unicode string.\r
+ @param[in] FormatString A Null-terminated Unicode format string.\r
+ @param[in] Marker VA_LIST marker for the variable argument list.\r
+\r
+ @retval NULL There was not enough available memory.\r
+ @return Null-terminated Unicode string is that is the formatted \r
+ string appended to String.\r
+**/\r
+CHAR16*\r
+EFIAPI\r
+CatVSPrint (\r
+ IN CHAR16 *String, OPTIONAL\r
+ IN CONST CHAR16 *FormatString,\r
+ IN VA_LIST Marker\r
+ )\r
+{\r
+ UINTN CharactersRequired;\r
+ UINTN SizeRequired;\r
+ CHAR16 *BufferToReturn;\r
+\r
+ CharactersRequired = SPrintLength(FormatString, Marker);\r
+\r
+ if (String != NULL) {\r
+ SizeRequired = StrSize(String) + (CharactersRequired * sizeof(CHAR16));\r
+ } else {\r
+ SizeRequired = sizeof(CHAR16) + (CharactersRequired * sizeof(CHAR16));\r
+ }\r
+\r
+ BufferToReturn = AllocateZeroPool(SizeRequired);\r
+\r
+ if (BufferToReturn == NULL) {\r
+ return NULL;\r
+ }\r
+\r
+ if (String != NULL) {\r
+ StrCpy(BufferToReturn, String);\r
+ }\r
+\r
+ UnicodeVSPrint(BufferToReturn + StrLen(BufferToReturn), (CharactersRequired+1) * sizeof(CHAR16), FormatString, Marker);\r
+\r
+ ASSERT(StrSize(BufferToReturn)==SizeRequired);\r
+\r
+ return (BufferToReturn);\r
+}\r
+\r
+/** \r
+ Appends a formatted Unicode string to a Null-terminated Unicode string\r
+ \r
+ This function appends a formatted Unicode string to the Null-terminated \r
+ Unicode string specified by String. String is optional and may be NULL.\r
+ Storage for the formatted Unicode string returned is allocated using \r
+ AllocatePool(). The pointer to the appended string is returned. The caller\r
+ is responsible for freeing the returned string.\r
+ \r
+ If String is not NULL and not aligned on a 16-bit boundary, then ASSERT().\r
+ If FormatString is NULL, then ASSERT().\r
+ If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
+ \r
+ @param[in] String A Null-terminated Unicode string.\r
+ @param[in] FormatString A Null-terminated Unicode format string.\r
+ @param[in] ... The variable argument list whose contents are \r
+ accessed based on the format string specified by \r
+ FormatString.\r
+\r
+ @retval NULL There was not enough available memory.\r
+ @return Null-terminated Unicode string is that is the formatted \r
+ string appended to String.\r
+**/\r
+CHAR16 *\r
+EFIAPI\r
+CatSPrint (\r
+ IN CHAR16 *String, OPTIONAL\r
+ IN CONST CHAR16 *FormatString,\r
+ ...\r
+ )\r
+{\r
+ VA_LIST Marker;\r
+ VA_START (Marker, FormatString);\r
+ return (CatVSPrint(String, FormatString, Marker));\r
+}\r
+\r
projects / mirror_edk2.git / blobdiff