EFI HII DATABASE NOTIFY

From PhoenixWiki

Jump to: navigation, search

Handle a registered notification for a package change to the database.

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_HII_DATABASE_NOTIFY) (
  IN UINT8                        PackageType,
  IN CONST EFI_GUID               *PackageGuid,
  IN CONST EFI_HII_PACKAGE_HEADER *Package,
  IN EFI_HII_HANDLE               Handle,
  IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
);

Parameters

Parameter Description
PackageType Package type of the notification.
PackageGuid If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then this is the pointer to the GUID from the Guid field of EFI_HII_GUID_PACKAGE_HDR. Otherwise, it must be NULL.
Package Points to the package referred to by the notification
Handle The handle of the package list which contains the specified package.
NotifyType The type of change concerning the database. See EFI_HII_DATABASE_NOTIFY_TYPE.

Description
Functions which are registered to receive notification of database events have this prototype. The actual event is encoded in NotifyType.

The following table describes how PackageType, PackageGuid, Handle, and Package are used for each of the notification types.

Notification Type Parameter Description
NEW_PACK PackageType and PackageGuid are the type of the new package. Package points to the new package. Handle is the handle of the package list which is being added to the database.
REMOVE_PACK PackageType and PackageGuid are the type of the package which is being removed. Package points to the package being removed. Handle is the package list from which the package is being removed.
EXPORT_PACK PackageType and PackageGuid are the type of the package being exported. Package points to the existing package in the database. Handle is the package list being exported.
ADD_PACK PackageType and PackageGuid are the type of the package being added. Package points to the package being added. Handle is the package list to which the package is being added.

Copyright (C) 2008 Phoenix Technologies Ltd. All Rights Reserved. Portions copyright (C) 2008 UEFI Forum, Inc. Used with permission

Personal tools