]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h
IntelFrameworkPkg: Clean up source files
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkFormBrowser.h
index 74c25e2733d6bc493a4b2656828372052e576a25..344d646f3925859e4eb32d5e6422536cd0a27de9 100644 (file)
@@ -5,13 +5,13 @@
   packet of data.  This will also allow the caller to post messages\r
   into the configuration drivers internal mailbox.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
 The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php.                                          \r
-    \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \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
 \r
   Module Name:  FrameworkFormBrowser.h\r
@@ -64,36 +64,36 @@ typedef struct {
 \r
   @param  This                  A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.\r
   @param  UseDatabase           Determines whether the HII database is to be\r
-                                used to gather information. If the value is FALSE, \r
-                                the configuration driver will get the information \r
+                                used to gather information. If the value is FALSE,\r
+                                the configuration driver will get the information\r
                                 provided in the passed-in Packet parameters.\r
-  @param  Handle                A pointer to an array of HII handles to display. \r
-                                This value should correspond to the value of the \r
+  @param  Handle                A pointer to an array of HII handles to display.\r
+                                This value should correspond to the value of the\r
                                 HII form package that is required to be displayed.\r
   @param  HandleCount           The number of handles in the array specified by Handle.\r
   @param  Packet                A pointer to a set of data containing pointers to IFR\r
                                 and/or string data.\r
   @param  CallbackHandle        The handle to the driver's callback interface.\r
-                                This parameter is used only when the UseDatabase \r
-                                parameter is FALSE and an application wants to \r
+                                This parameter is used only when the UseDatabase\r
+                                parameter is FALSE and an application wants to\r
                                 register a callback with the browser.\r
   @param  NvMapOverride         This buffer is used only when there is no NV variable\r
-                                to define the current settings and the caller needs \r
-                                to provide to the browser the current settings for \r
+                                to define the current settings and the caller needs\r
+                                to provide to the browser the current settings for\r
                                 the "fake" NV variable.\r
   @param  ScreenDimensions      Allows the browser to be called so that it occupies\r
-                                a portion of the physical screen instead of dynamically \r
+                                a portion of the physical screen instead of dynamically\r
                                 determining the screen dimensions.\r
   @param  ResetRequired         This BOOLEAN value denotes whether a reset is required\r
-                                based on the data that might have been changed. \r
-                                The ResetRequired parameter is primarily applicable \r
+                                based on the data that might have been changed.\r
+                                The ResetRequired parameter is primarily applicable\r
                                 for configuration applications, and is an\r
                                 optional parameter.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_FOUND         The variable was not found.\r
   @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the result.\r
-                                DataSize has been updated with the size needed to \r
+                                DataSize has been updated with the size needed to\r
                                 complete the request.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
   @retval EFI_DEVICE_ERROR      The variable could not be saved due to a hardware failure.\r
@@ -119,10 +119,10 @@ EFI_STATUS
 \r
   @param  NumberOfLines         The number of lines for the dialog box.\r
   @param  HotKey                Defines whether a single character is parsed (TRUE)\r
-                                and returned in KeyValue, or if a string is returned \r
+                                and returned in KeyValue, or if a string is returned\r
                                 in StringBuffer.\r
   @param  MaximumStringSize     The maximum size in bytes of a typed-in string.\r
-                                Because each character is a CHAR16, the minimum \r
+                                Because each character is a CHAR16, the minimum\r
                                 string returned is two bytes.\r
   @param  StringBuffer          The passed-in pointer to the buffer that will hold\r
                                 the typed in string if HotKey is FALSE.\r
@@ -160,10 +160,10 @@ struct _EFI_FORM_BROWSER_PROTOCOL {
   /// a pointer to the calling driver's callback interface.\r
   ///\r
   EFI_SEND_FORM     SendForm;\r
-  \r
+\r
   ///\r
   /// Routine used to abstract a generic dialog interface and return the\r
-  /// selected key or string.  \r
+  /// selected key or string.\r
   ///\r
   EFI_CREATE_POP_UP CreatePopUp;\r
 };\r