The file provides Database manager for HII-related data\r
structures.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation\r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. 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
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \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
+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
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
**/\r
\r
\r
\r
///\r
-/// EFI_HII_DATABASE_NOTIFY_TYPE\r
+/// EFI_HII_DATABASE_NOTIFY_TYPE.\r
/// \r
typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE;\r
\r
be called. For each call to NewPackageList(), there should be a\r
corresponding call to\r
EFI_HII_DATABASE_PROTOCOL.RemovePackageList().\r
-\r
+ \r
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
\r
@param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER structure.\r
\r
@param DriverHandle Associate the package list with this EFI handle.\r
+ If a NULL is specified, this data will not be associate\r
+ with any drivers and cannot have a callback induced.\r
\r
@param Handle A pointer to the EFI_HII_HANDLE instance.\r
\r
resources for the new database\r
contents.\r
\r
- @retval EFI_INVALID_PARAMETER PackageList is NULL or Handle is NULL.\r
+ @retval EFI_INVALID_PARAMETER PackageList is NULL, or Handle is NULL.\r
\r
**/\r
typedef\r
(EFIAPI *EFI_HII_DATABASE_NEW_PACK)(\r
IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
IN CONST EFI_HII_PACKAGE_LIST_HEADER *PackageList,\r
- IN EFI_HANDLE DriverHandle,\r
+ IN EFI_HANDLE DriverHandle, OPTIONAL\r
OUT EFI_HII_HANDLE *Handle\r
);\r
\r
EFI_HII_PACKAGE_TYPE_GUID, the Guid field, as defined in\r
EFI_HII_PACKAGE_GUID_HEADER. Iterate through the packages within\r
the existing package list in the HII database specified by\r
- Handle. If a package??s type matches one of the types collected\r
+ Handle. If a package's type matches one of the collected types collected\r
in step 1, then perform the following steps:\r
- Call any functions registered with the notification type\r
REMOVE_PACK.\r
the length of the handle buffer\r
that is required for the handles found.\r
\r
- @param Handle An array of EFI_HII_HANDLE instances returned.\r
+ @param Handle An array of EFI_HII_HANDLE instances returned.\r
\r
- @retval EFI_SUCCESS The matching handles are outputed successfully.\r
+ @retval EFI_SUCCESS The matching handles are outputted successfully.\r
HandleBufferLength is updated with the actual length.\r
@retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter\r
indicates that Handle is too\r
handles. HandleBufferLength is\r
updated with a value that will\r
enable the data to fit.\r
- @retval EFI_NOT_FOUND No matching handle could not be found in database.\r
- @retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.\r
+ @retval EFI_NOT_FOUND No matching handle could be found in database.\r
+ @retval EFI_INVALID_PARAMETER HandleBufferLength was NULL.\r
+ @retval EFI_INVALID_PARAMETER The value referenced by HandleBufferLength was not\r
+ zero and Handle was NULL.\r
@retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but\r
PackageGuid is not NULL, PackageType is a EFI_HII_\r
PACKAGE_TYPE_GUID but PackageGuid is NULL.\r
\r
@retval EFI_OUT_OF_RESOURCES BufferSize is too small to hold the package.\r
\r
+ @retval EFI_NOT_FOUND The specified Handle could not be found in the\r
+ current database.\r
+ \r
+ @retval EFI_INVALID_PARAMETER BufferSize was NULL.\r
+ \r
+ @retval EFI_INVALID_PARAMETER The value referenced by BufferSize was not zero \r
+ and Buffer was NULL.\r
**/\r
typedef\r
EFI_STATUS\r
\r
@param NotifyType Describes the types of notification which\r
this function will be receiving. See\r
- EFI_HII_DATABASE_NOTIFY_TYPE for more a\r
+ EFI_HII_DATABASE_NOTIFY_TYPE for a\r
list of types.\r
\r
@param NotifyHandle Points to the unique handle assigned to\r
@param NotificationHandle The handle of the notification\r
function being unregistered.\r
\r
- @retval EFI_SUCCESS Unregister the notification Successsfully\r
+ @retval EFI_SUCCESS Successsfully unregistered the notification. \r
\r
@retval EFI_NOT_FOUND The incoming notification handle does not exist \r
- in current hii database.\r
+ in the current hii database.\r
\r
**/\r
typedef\r
KeyGuidBufferLength is updated\r
with a value that will enable\r
the data to fit.\r
+ @retval EFI_INVALID_PARAMETER The KeyGuidBufferLength is NULL.\r
+ @retval EFI_INVALID_PARAMETER The value referenced by \r
+ KeyGuidBufferLength is not\r
+ zero and KeyGuidBuffer is NULL.\r
+ @retval EFI_NOT_FOUND There was no keyboard layout.\r
\r
**/\r
typedef\r
/**\r
\r
This routine retrieves the requested keyboard layout. The layout\r
- is a physical description of the keys on a keyboard and the\r
+ is a physical description of the keys on a keyboard, and the\r
character(s) that are associated with a particular set of key\r
strokes.\r
\r
(EFIAPI *EFI_HII_GET_KEYBOARD_LAYOUT)(\r
IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
IN CONST EFI_GUID *KeyGuid,\r
- IN OUT UINT16 *KeyboardLayoutLength,\r
+ IN OUT UINT16 *KeyboardLayoutLength,\r
OUT EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout\r
);\r
\r
projects / mirror_edk2.git / blobdiff