Clarify clipping behavior of PrintXY() and AsciiPrintXY().

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8271 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h
index 401695293a097ee7fa8d79c820033ca569f9f67d..fd93dcc719a5bf82b16830b9ea188e8e3dc1d966 100644 (file)
--- a/MdePkg/Include/Library/UefiLib.h
+++ b/MdePkg/Include/Library/UefiLib.h
@@ -1074,8 +1074,9 @@ AsciiErrorPrint (
 \r
   This function prints a formatted Unicode string to the graphics console device \r
   specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of \r
-  Unicode characters printed.  If the length of the formatted Unicode string is\r
-  greater than PcdUefiLibMaxPrintBufferSize, then only the first \r
+  Unicode characters displayed, not including partial characters that may be clipped \r
+  by the right edge of the display.  If the length of the formatted Unicode string is\r
+  greater than PcdUefiLibMaxPrintBufferSize, then at most the first \r
   PcdUefiLibMaxPrintBufferSize characters are printed.  The EFI_HII_FONT_PROTOCOL\r
   is used to convert the string to a bitmap using the glyphs registered with the \r
   HII database.  No wrapping is performed, so any portions of the string the fall\r
@@ -1123,8 +1124,9 @@ PrintXY (
 \r
   This function prints a formatted ASCII string to the graphics console device \r
   specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of \r
-  ASCII characters printed.  If the length of the formatted ASCII string is\r
-  greater than PcdUefiLibMaxPrintBufferSize, then only the first \r
+  ASCII characters displayed, not including partial characters that may be clipped \r
+  by the right edge of the display.  If the length of the formatted ASCII string is\r
+  greater than PcdUefiLibMaxPrintBufferSize, then at most the first \r
   PcdUefiLibMaxPrintBufferSize characters are printed.  The EFI_HII_FONT_PROTOCOL\r
   is used to convert the string to a bitmap using the glyphs registered with the \r
   HII database.  No wrapping is performed, so any portions of the string the fall\r

diff --git a/MdePkg/Library/UefiLib/UefiLibPrint.c b/MdePkg/Library/UefiLib/UefiLibPrint.c
index d9268ef52de7f43b735641670f3da8315673b75b..0ee2c23eb2da261c75341e474f534b8ef8e4e33b 100644 (file)
--- a/MdePkg/Library/UefiLib/UefiLibPrint.c
+++ b/MdePkg/Library/UefiLib/UefiLibPrint.c
@@ -535,8 +535,9 @@ Error:
 \r
   This function prints a formatted Unicode string to the graphics console device \r
   specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of \r
-  Unicode characters printed.  If the length of the formatted Unicode string is\r
-  greater than PcdUefiLibMaxPrintBufferSize, then only the first \r
+  Unicode characters displayed, not including partial characters that may be clipped \r
+  by the right edge of the display.  If the length of the formatted Unicode string is\r
+  greater than PcdUefiLibMaxPrintBufferSize, then at most the first \r
   PcdUefiLibMaxPrintBufferSize characters are printed.  The EFI_HII_FONT_PROTOCOL\r
   is used to convert the string to a bitmap using the glyphs registered with the \r
   HII database.  No wrapping is performed, so any portions of the string the fall\r
@@ -609,8 +610,9 @@ PrintXY (
 \r
   This function prints a formatted ASCII string to the graphics console device \r
   specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of \r
-  ASCII characters printed.  If the length of the formatted ASCII string is\r
-  greater than PcdUefiLibMaxPrintBufferSize, then only the first \r
+  ASCII characters displayed, not including partial characters that may be clipped \r
+  by the right edge of the display.  If the length of the formatted ASCII string is\r
+  greater than PcdUefiLibMaxPrintBufferSize, then at most the first \r
   PcdUefiLibMaxPrintBufferSize characters are printed.  The EFI_HII_FONT_PROTOCOL\r
   is used to convert the string to a bitmap using the glyphs registered with the \r
   HII database.  No wrapping is performed, so any portions of the string the fall\r