diff options
Diffstat (limited to 'src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h')
-rw-r--r-- | src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h index de132f88c0..396891ebad 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h @@ -1,17 +1,17 @@ /** @file This protocol is defined in UEFI spec. - - The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to + + The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to leverage the EFI configuration driver interface. - + Copyright (c) 2006 - 2015, 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. +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. +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. **/ @@ -29,11 +29,11 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL EFI_FORM_BROWSER2_PROTOCOL; /** - + @param LeftColumn The value that designates the text column where the browser window will begin from the left-hand side of the screen - + @param RightColumn The value that designates the text column where the browser window will end on the right-hand side of the screen. @@ -44,7 +44,7 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL EFI_FORM_BROWSER2_PROTOCOL; @param BottomRow The value that designates the text row from the bottom of the screen where the browser - window will end. + window will end. **/ typedef struct { UINTN LeftColumn; @@ -69,14 +69,14 @@ typedef UINTN EFI_BROWSER_ACTION_REQUEST; /** Initialize the browser to display the specified configuration forms. - This function is the primary interface to the internal forms-based browser. - The forms browser will display forms associated with the specified Handles. - The browser will select all forms in packages which have the specified Type + This function is the primary interface to the internal forms-based browser. + The forms browser will display forms associated with the specified Handles. + The browser will select all forms in packages which have the specified Type and (for EFI_HII_PACKAGE_TYPE_GUID) the specified PackageGuid. @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance - @param Handles A pointer to an array of Handles. This value should correspond + @param Handles A pointer to an array of Handles. This value should correspond to the value of the HII form package that is required to be displayed. @param HandleCount The number of Handles specified in Handle. @@ -90,17 +90,17 @@ typedef UINTN EFI_BROWSER_ACTION_REQUEST; displayable page. If this field has a value of 0x0000, then the Forms Browser will render the first enabled form in the form set. - @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in + @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in characters. @param ActionRequest Points to the action recommended by the form. @retval EFI_SUCCESS The function completed successfully - + @retval EFI_NOT_FOUND The variable was not found. - + @retval EFI_INVALID_PARAMETER One of the parameters has an - invalid value. + invalid value. **/ typedef EFI_STATUS @@ -126,7 +126,7 @@ EFI_STATUS @param ResultsDataSize A pointer to the size of the buffer associated with ResultsData. On input, the size in - bytes of ResultsData. On output, the size of data + bytes of ResultsData. On output, the size of data returned in ResultsData. @param ResultsData A string returned from an IFR browser or @@ -148,7 +148,7 @@ EFI_STATUS @retval EFI_SUCCESS The results have been distributed or are awaiting distribution. - + @retval EFI_OUT_OF_RESOURCES The ResultsDataSize specified was too small to contain the results data. @@ -166,7 +166,7 @@ EFI_STATUS ); /// -/// This interface will allow the caller to direct the configuration +/// This interface will allow the caller to direct the configuration /// driver to use either the HII database or use the passed-in packet of data. /// struct _EFI_FORM_BROWSER2_PROTOCOL { |