[mirror_edk2.git] / IntelFrameworkPkg / Include / Library / FrameworkHiiLib.h

/** @file\r
  Library class name: FrameworkHiiLib.\r
  \r
  FrameworkHiiLib is designed for produce interfaces to access\r
  framework HII things. It firstly also produce all interfaces define\r
  in HiiLib library class in MdePkg/Include/HiiLib.h. It also produce\r
  framework's old interface PreparePackages to keep compatiblity.\r
     \r
  Copyright (c) 2006, 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
\r
**/\r
\r
#ifndef __FRAMEWORK_HII_LIB_H__\r
#define __FRAMEWORK_HII_LIB_H__\r
\r
#include <FrameworkDxe.h>\r
\r
#include <Protocol/FrameworkHii.h>\r
//\r
// FrameworkHiiLib will produce HiiLib library class too.\r
//\r
#include <Library/HiiLib.h>\r
\r
/**\r
  This function allocates pool for an EFI_HII_PACKAGES structure\r
  with enough space for the variable argument list of package pointers.\r
  The allocated structure is initialized using NumberOfPackages, Guid,\r
  and the variable length argument list of package pointers.\r
\r
  @param  NumberOfPackages  The number of HII packages to prepare.\r
  @param  Guid              Package GUID.\r
  @param  ...               The variable argument list of package pointers.\r
\r
  @return                   The allocated and initialized packages.\r
**/\r
EFI_HII_PACKAGES *\r
EFIAPI\r
PreparePackages (\r
  IN UINTN           NumberOfPackages,\r
  IN CONST EFI_GUID  *Guid OPTIONAL,\r
  ...\r
  );\r
\r
#endif\r
Commit	Line	Data
0a869bf8	1	/** @file\r
4a71b21a	2	Library class name: FrameworkHiiLib.\r
	3	\r
	4	FrameworkHiiLib is designed for produce interfaces to access\r
	5	framework HII things. It firstly also produce all interfaces define\r
	6	in HiiLib library class in MdePkg/Include/HiiLib.h. It also produce\r
	7	framework's old interface PreparePackages to keep compatiblity.\r
	8	\r
0a869bf8	9	Copyright (c) 2006, Intel Corporation \r
	10	All rights reserved. This program and the accompanying materials \r
	11	are licensed and made available under the terms and conditions of the BSD License \r
	12	which accompanies this distribution. The full text of the license may be found at \r
	13	http://opensource.org/licenses/bsd-license.php \r
	14	\r
	15	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	16	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	17	\r
0a869bf8	18	**/\r
0a869bf8	19	\r
dc7b4a5c	20	#ifndef __FRAMEWORK_HII_LIB_H__\r
	21	#define __FRAMEWORK_HII_LIB_H__\r
	22	\r
	23	#include <FrameworkDxe.h>\r
0a869bf8	24	\r
8e5b17b2	25	#include <Protocol/FrameworkHii.h>\r
dc7b4a5c	26	//\r
	27	// FrameworkHiiLib will produce HiiLib library class too.\r
	28	//\r
	29	#include <Library/HiiLib.h>\r
7c6d55db	30	\r
0a869bf8	31	/**\r
	32	This function allocates pool for an EFI_HII_PACKAGES structure\r
	33	with enough space for the variable argument list of package pointers.\r
a45eb10f	34	The allocated structure is initialized using NumberOfPackages, Guid,\r
0a869bf8	35	and the variable length argument list of package pointers.\r
0a869bf8	36	\r
a45eb10f	37	@param NumberOfPackages The number of HII packages to prepare.\r
a45eb10f	38	@param Guid Package GUID.\r
409f118c	39	@param ... The variable argument list of package pointers.\r
0a869bf8	40	\r
409f118c	41	@return The allocated and initialized packages.\r
0a869bf8	42	**/\r
	43	EFI_HII_PACKAGES *\r
	44	EFIAPI\r
	45	PreparePackages (\r
	46	IN UINTN NumberOfPackages,\r
	47	IN CONST EFI_GUID *Guid OPTIONAL,\r
	48	...\r
ed66e1bc	49	);\r
0a869bf8	50	\r
0a869bf8	51	#endif\r