UEFI HII: Merge UEFI HII support changes from branch.

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

/** @file\r
  Public include file for the HII Library\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
  Module Name:  HiiLib.h\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
\r
  @return\r
  The allocated and initialized packages.\r
\r
**/\r
EFI_HII_PACKAGES *\r
EFIAPI\r
PreparePackages (\r
  IN UINTN           NumberOfPackages,\r
  IN CONST EFI_GUID  *Guid OPTIONAL,\r
  ...\r
  )\r
;\r
\r
#endif\r