HII Library Class interface refine.

[mirror_edk2.git] / MdeModulePkg / Library / UefiHiiLib / InternalHiiLib.h

/** @file\r
  Internal include file for the HII Library instance.\r
\r
  Copyright (c) 2007, 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 __INTERNAL_HII_LIB_H__\r
#define __INTERNAL_HII_LIB_H__\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/HiiDatabase.h>\r
#include <Protocol/HiiString.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/FormBrowser2.h>\r
\r
#include <Guid/GlobalVariable.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
\r
#define HII_LIB_DEFAULT_STRING_SIZE     0x200\r
\r
///\r
/// The size of a 3 character ISO639 language code.\r
///\r
#define ISO_639_2_ENTRY_SIZE    3\r
\r
extern CONST EFI_HII_DATABASE_PROTOCOL         *mHiiDatabaseProt;\r
extern CONST EFI_HII_STRING_PROTOCOL           *mHiiStringProt;\r
\r
/**\r
  Extract Hii package list GUID for given HII handle.\r
\r
  If HiiHandle could not be found in the HII database, then ASSERT.\r
  If Guid is NULL, then ASSERT.\r
\r
  @param  Handle              Hii handle\r
  @param  Guid                Package list GUID\r
\r
  @retval EFI_SUCCESS            Successfully extract GUID from Hii database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InternalHiiExtractGuidFromHiiHandle (\r
  IN      EFI_HII_HANDLE      Handle,\r
  OUT     EFI_GUID            *Guid\r
  )\r
;\r
\r
#endif\r