add a error macro to prevent this file from included for now #error "UEFI 2.1 HII...
[mirror_edk2.git] / MdePkg / Include / Library / HiiLib.h
CommitLineData
fb3df220 1/** @file\r
2 Public include file for the HII Library\r
3\r
4 Copyright (c) 2006, Intel Corporation \r
5 All rights reserved. This program and the accompanying materials \r
6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
fb3df220 13**/\r
14\r
15#ifndef __HII_LIB_H__\r
16#define __HII_LIB_H__\r
17\r
1528fae8 18#error "UEFI 2.1 HII is not fully implemented for now, Please don't include this file now."\r
19\r
fb3df220 20#include <Protocol/HiiDatabase.h>\r
21\r
22/**\r
23 This function allocates pool for an EFI_HII_PACKAGES structure\r
24 with enough space for the variable argument list of package pointers.\r
25 The allocated structure is initialized using NumberOfPackages, Guid, \r
26 and the variable length argument list of package pointers.\r
27\r
28 @param NumberOfPackages The number of HII packages to prepare.\r
29 @param Guid Package GUID.\r
30\r
31 @return\r
32 The allocated and initialized packages.\r
33\r
34**/\r
c7d265a9 35EFI_HII_PACKAGE_LIST_HEADER *\r
fb3df220 36EFIAPI\r
37PreparePackages (\r
c7d265a9 38 IN CONST UINTN NumberOfPackages,\r
39 IN CONST EFI_GUID *Guid OPTIONAL,\r
fb3df220 40 ...\r
c7d265a9 41 );\r
fb3df220 42\r
43#endif\r