IntelFrameworkPkg/Include/Library/FrameworkHiiLib.h

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