X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FFrameworkFormBrowser.h;h=74c25e2733d6bc493a4b2656828372052e576a25;hb=c5b900bed8bab2f16149c48f11c525690611b33d;hp=db3809a6bb2b642ab7f7c1dfa227a357e22d6d22;hpb=2bbaeb0d624f1d7758edd0a8d61322af209a1b1a;p=mirror_edk2.git diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h b/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h index db3809a6bb..74c25e2733 100644 --- a/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h +++ b/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h @@ -1,18 +1,18 @@ /** @file The EFI_FORM_BROWSER_PROTOCOL is the interface to the EFI - Configuration Driver. This will allow the caller to direct the - configuration driver to use either the HII database or use the passed - in packet of data. This will also allow the caller to post messages + Configuration Driver. This interface enables the caller to direct the + configuration driver to use either the HII database or the passed-in + packet of data. This will also allow the caller to post messages into the configuration drivers internal mailbox. - Copyright (c) 2006 - 2009, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which 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. +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
+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. Module Name: FrameworkFormBrowser.h @@ -48,7 +48,7 @@ typedef struct { typedef struct { EFI_HII_IFR_PACK *IfrData; EFI_HII_STRING_PACK *StringData; -} FRAMEWORK_EFI_IFR_PACKET; +} EFI_IFR_PACKET; typedef struct { UINTN LeftColumn; @@ -64,32 +64,37 @@ typedef struct { @param This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance. @param UseDatabase Determines whether the HII database is to be - used to gather information. If the value is FALSE, the configuration - driver will get the information provided in the passed-in Packet parameters. - @param Handle A pointer to an array of HII handles to display. This value - should correspond to the value of the HII form package that is required to - be displayed. + used to gather information. If the value is FALSE, + the configuration driver will get the information + provided in the passed-in Packet parameters. + @param Handle A pointer to an array of HII handles to display. + This value should correspond to the value of the + HII form package that is required to be displayed. @param HandleCount The number of handles in the array specified by Handle. @param Packet A pointer to a set of data containing pointers to IFR and/or string data. @param CallbackHandle The handle to the driver's callback interface. - This parameter is used only when the UseDatabase parameter is FALSE - and an application wants to register a callback with the browser + This parameter is used only when the UseDatabase + parameter is FALSE and an application wants to + register a callback with the browser. @param NvMapOverride This buffer is used only when there is no NV variable - to define the current settings and the caller needs to provide to the browser - the current settings for the "fake" NV variable. + to define the current settings and the caller needs + to provide to the browser the current settings for + the "fake" NV variable. @param ScreenDimensions Allows the browser to be called so that it occupies - a portion of the physical screen instead of dynamically determining the - screen dimensions. - @param ResetRequired This BOOLEAN value will tell the caller if a reset - is required based on the data that might have been changed. The ResetRequired - parameter is primarily applicable for configuration applications, and is an + a portion of the physical screen instead of dynamically + determining the screen dimensions. + @param ResetRequired This BOOLEAN value denotes whether a reset is required + based on the data that might have been changed. + The ResetRequired parameter is primarily applicable + for configuration applications, and is an optional parameter. - @retval EFI_SUCCESS The function completed successfully + @retval EFI_SUCCESS The function completed successfully. @retval EFI_NOT_FOUND The variable was not found. @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. - DataSize has been updated with the size needed to complete the request. + DataSize has been updated with the size needed to + complete the request. @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure. @@ -101,7 +106,7 @@ EFI_STATUS IN BOOLEAN UseDatabase, IN FRAMEWORK_EFI_HII_HANDLE *Handle, IN UINTN HandleCount, - IN FRAMEWORK_EFI_IFR_PACKET *Packet, OPTIONAL + IN EFI_IFR_PACKET *Packet, OPTIONAL IN EFI_HANDLE CallbackHandle, OPTIONAL IN UINT8 *NvMapOverride, OPTIONAL IN FRAMEWORK_EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL @@ -114,9 +119,11 @@ EFI_STATUS @param NumberOfLines The number of lines for the dialog box. @param HotKey Defines whether a single character is parsed (TRUE) - and returned in KeyValue or if a string is returned in StringBuffer. + and returned in KeyValue, or if a string is returned + in StringBuffer. @param MaximumStringSize The maximum size in bytes of a typed-in string. - Because each character is a CHAR16, the minimum string returned is two bytes. + Because each character is a CHAR16, the minimum + string returned is two bytes. @param StringBuffer The passed-in pointer to the buffer that will hold the typed in string if HotKey is FALSE. @param KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE. @@ -149,7 +156,7 @@ EFI_STATUS struct _EFI_FORM_BROWSER_PROTOCOL { /// /// Provides direction to the configuration driver whether to use the HII - /// database or to use a passed-in set of data. This functions also establishes + /// database or to use a passed-in set of data. This function also establishes /// a pointer to the calling driver's callback interface. /// EFI_SEND_FORM SendForm;