EdkCompatibilityPkg/Compatibility/FrameworkHiiOnUefiHiiThunk/HiiHandle.h

   1 /** @file
   2   This file is for functins related to assign and free Framework HII handle number.
   3
   4 Copyright (c) 2006 - 2010, Intel Corporation
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _HII_HANDLE_H_
  16 #define _HII_HANDLE_H_
  17
  18 #include <FrameworkDxe.h>
  19 #include <Protocol/FrameworkHii.h>
  20 #include <Library/DebugLib.h>
  21
  22 /**
  23
  24   Initialize the Framework Hii Handle database.
  25
  26 **/
  27 VOID
  28 InitHiiHandleDatabase (
  29   VOID
  30   );
  31
  32 /**
  33   Allocate a new Framework HII handle.
  34
  35   @param  Handle Returns the new Framework HII Handle assigned.
  36
  37   @retval EFI_SUCCESS         A new Framework HII Handle is assigned.
  38   @retval EFI_OUT_OF_RESOURCE The Framework HII Handle database is depleted.
  39
  40 **/
  41 EFI_STATUS
  42 AllocateHiiHandle (
  43   OUT FRAMEWORK_EFI_HII_HANDLE *Handle
  44   );
  45
  46
  47 /**
  48   Free Framework HII handle.
  49
  50   @param  Handle The Framework HII Handle to be freed.
  51
  52 **/
  53 VOID
  54 FreeHiiHandle (
  55   IN FRAMEWORK_EFI_HII_HANDLE Handle
  56   );
  57
  58
  59 #endif
  60