]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/UefiLib.h
Second set of changes based on a review of the code comments in the Include directory...
[mirror_edk2.git] / MdePkg / Include / Library / UefiLib.h
index 1853f810a243ee4484689b8c11130999b03430d4..56352dbf30bc5e68a0608c0d79bf174cb09d153d 100644 (file)
@@ -113,8 +113,8 @@ typedef struct {
   based on a specified GUID.\r
   \r
   This function searches the list of configuration tables stored in the EFI System Table\r
-  for a table with a GUID that matches TableGuid.  If a match is found, then a pointer to\r
-  the configuration table is returned in Table., and EFI_SUCCESS is returned. If a matching GUID\r
+  for a table with a GUID that matches TableGuid. If a match is found, then a pointer to\r
+  the configuration table is returned in Table, and EFI_SUCCESS is returned. If a matching GUID\r
   is not found, then EFI_NOT_FOUND is returned.\r
   If TableGuid is NULL, then ASSERT().\r
   If Table is NULL, then ASSERT().\r
@@ -716,6 +716,31 @@ GetBestLanguage (
   ...\r
   );\r
 \r
+/**\r
+  Draws a dialog box to the console output device specified by \r
+  ConOut defined in the EFI_SYSTEM_TABLE and waits for a keystroke\r
+  from the console input device specified by ConIn defined in the \r
+  EFI_SYSTEM_TABLE.\r
+\r
+  If there are no strings in the variable argument list, then ASSERT().\r
+  If all the strings in the variable argument list are empty, then ASSERT().\r
+\r
+  @param[in]   Attribute  Specifies the foreground and background color of the popup.\r
+  @param[out]  Key        A pointer to the EFI_KEY value of the key that was \r
+                          pressed.  This is an optional parameter that may be NULL.\r
+                          If it is NULL then no wait for a keypress will be performed.\r
+  @param[in]  ...         The variable argument list that contains pointers to Null-\r
+                          terminated Unicode strings to display in the dialog box.  \r
+                          The variable argument list is terminated by a NULL.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+CreatePopUp (\r
+  IN  UINTN          Attribute,                \r
+  OUT EFI_INPUT_KEY  *Key,      OPTIONAL\r
+  ...\r
+  );\r
 \r
 /**\r
   Retrieves the width of a Unicode character.\r
@@ -923,7 +948,7 @@ EfiInitializeFwVolDevicepathNode (
   This library function abstracts validating a device path node.\r
   Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid.  \r
   If it is valid, then return the GUID file name from the device path node.  Otherwise, \r
-  return NULL.  This device path changed in the DXE CIS version 0.92 in a non back ward \r
+  return NULL.  This device path changed in the DXE CIS version 0.92 in a non backward \r
   compatible way to not conflict with the UEFI 2.0 specification.  This function abstracts \r
   the differences from the caller.\r
   If FvDevicePathNode is NULL, then ASSERT().\r
@@ -1042,14 +1067,16 @@ AsciiErrorPrint (
   ...\r
   );\r
 \r
+\r
 /**\r
   Prints a formatted Unicode string to a graphics console device specified by \r
   ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.\r
 \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
@@ -1062,8 +1089,8 @@ AsciiErrorPrint (
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
-  @param  X            X coordinate to print the string.\r
-  @param  Y            Y coordinate to print the string.\r
+  @param  PointX       X coordinate to print the string.\r
+  @param  PointY       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
@@ -1083,8 +1110,8 @@ AsciiErrorPrint (
 UINTN\r
 EFIAPI\r
 PrintXY (\r
-  IN UINTN                            X,\r
-  IN UINTN                            Y,\r
+  IN UINTN                            PointX,\r
+  IN UINTN                            PointY,\r
   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *ForeGround, OPTIONAL\r
   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *BackGround, OPTIONAL\r
   IN CONST CHAR16                     *Format,\r
@@ -1097,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
@@ -1110,8 +1138,8 @@ PrintXY (
   string is printed, and 0 is returned.\r
   If Format is NULL, then ASSERT().\r
 \r
-  @param  X            X coordinate to print the string.\r
-  @param  Y            Y coordinate to print the string.\r
+  @param  PointX       X coordinate to print the string.\r
+  @param  PointY       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
@@ -1131,8 +1159,8 @@ PrintXY (
 UINTN\r
 EFIAPI\r
 AsciiPrintXY (\r
-  IN UINTN                            X,\r
-  IN UINTN                            Y,\r
+  IN UINTN                            PointX,\r
+  IN UINTN                            PointY,\r
   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *ForeGround, OPTIONAL\r
   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *BackGround, OPTIONAL\r
   IN CONST CHAR8                      *Format,\r
@@ -1178,7 +1206,7 @@ EfiLibInstallDriverBinding (
   Initializes a driver by installing the Driver Binding Protocol together with the\r
   optional Component Name, optional Driver Configure and optional Driver Diagnostic\r
   Protocols onto the driver's DriverBindingHandle. If DriverBindingHandle is NULL,\r
-  then the protocols are  installed onto a newly created handle. DriverBindingHandle\r
+  then the protocols are installed onto a newly created handle. DriverBindingHandle\r
   is typically the same as the driver's ImageHandle, but it can be different if the\r
   driver produces multiple Driver Binding Protocols. \r
   If DriverBinding is NULL, then ASSERT(). \r