database or a passed-in set of data. This function also establishes a \r
pointer to the calling driver¡¯s callback interface. \r
\r
- @param This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.\r
- \r
- @param UseDatabase Determines whether the HII database is to be \r
- used to gather information. If the value is FALSE, the configuration \r
- driver will get the information provided in the passed-in Packet parameters.\r
- \r
- @param Handle A pointer to an array of HII handles to display. This value \r
- should correspond to the value of the HII form package that is required to \r
- be displayed.\r
- \r
- @param HandleCount The number of handles in the array specified by Handle.\r
- \r
- @param Packet A pointer to a set of data containing pointers to IFR \r
- and/or string data. \r
- \r
- @param CallbackHandle The handle to the driver¡¯s callback interface. \r
- This parameter is used only when the UseDatabase parameter is FALSE \r
- and an application wants to register a callback with the browser\r
- \r
- @param NvMapOverride This buffer is used only when there is no NV variable \r
- to define the current settings and the caller needs to provide to the browser \r
- the current settings for the "fake" NV variable.\r
- \r
- @param ScreenDimensions Allows the browser to be called so that it occupies \r
- a portion of the physical screen instead of dynamically determining the \r
- screen dimensions. \r
- \r
- @param ResetRequired This BOOLEAN value will tell the caller if a reset \r
- is required based on the data that might have been changed. The ResetRequired \r
- parameter is primarily applicable for configuration applications, and is an \r
- optional parameter. \r
-\r
- @retval EFI_SUCCESS The function completed successfully\r
- \r
- @retval EFI_NOT_FOUND The variable was not found.\r
- \r
- @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. \r
- DataSize has been updated with the size needed to complete the request.\r
- \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, the configuration\r
+ driver will get the information provided in the passed-in Packet parameters.\r
+ @param Handle A pointer to an array of HII handles to display. This value\r
+ should correspond to the value of the HII form package that is required to\r
+ 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 parameter is FALSE\r
+ and an application wants to 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 to provide to the browser\r
+ the current settings for 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 determining the\r
+ screen dimensions.\r
+ @param ResetRequired This BOOLEAN value will tell the caller if a reset\r
+ is required based on the data that might have been changed. The ResetRequired\r
+ parameter is primarily applicable 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 complete the request.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
- \r
- @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure. \r
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r
\r
**/\r
typedef\r
Routine used to abstract a generic dialog interface and return the selected \r
key or string.\r
\r
- @param NumberOfLines The number of lines for the dialog box.\r
- \r
- @param HotKey Defines whether a single character is parsed (TRUE) \r
- and returned in KeyValue or if a string is returned in StringBuffer. \r
- \r
- @param MaximumStringSize The maximum size in bytes of a typed-in string. \r
- Because each character is a CHAR16, the minimum string returned is two bytes.\r
- \r
- @param StringBuffer The passed-in pointer to the buffer that will hold \r
- the typed in string if HotKey is FALSE.\r
- \r
- @param KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE.\r
- \r
- @param String The pointer to the first string in the list of strings \r
- that comprise the dialog box.\r
- \r
- @param ... A series of NumberOfLines text strings that will be used \r
- to construct the dialog box. \r
-\r
- @retval EFI_SUCCESS The dialog was displayed and user interaction was received.\r
- \r
- @retval EFI_DEVICE_ERROR The user typed in an ESC character to exit the routine.\r
- \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 in StringBuffer.\r
+ @param MaximumStringSize The maximum size in bytes of a typed-in string.\r
+ Because each character is a CHAR16, the minimum 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
+ @param KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE.\r
+ @param String The pointer to the first string in the list of strings\r
+ that comprise the dialog box.\r
+ @param ... A series of NumberOfLines text strings that will be used\r
+ to construct the dialog box.\r
+\r
+ @retval EFI_SUCCESS The dialog was displayed and user interaction was received.\r
+ @retval EFI_DEVICE_ERROR The user typed in an ESC character to exit the routine.\r
@retval EFI_INVALID_PARAMETER One of the parameters was invalid\r
\r
**/\r
projects / mirror_edk2.git / blobdiff