[mirror_edk2.git] / MdeModulePkg / Include / Library / ExtendedHiiLib.h

/** @file\r
  This library includes the APIs that is specific to EDK II's implementation.\r
  It extended the UEFI Specification to define GUIDed device path.\r
\r
  Copyright (c) 2008, 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 __EXTENDED_HII_LIB_H__\r
#define __EXTENDED_HII_LIB_H__\r
\r
/**\r
  The HII driver handle passed in for HiiDatabase.NewPackageList() requires\r
  that there should be DevicePath Protocol installed on it.\r
  This routine create a virtual Driver Handle by installing a vendor device\r
  path on it, so as to use it to invoke HiiDatabase.NewPackageList().\r
  The Device Path created is a Vendor Device Path specific to Intel's implemenation.\r
\r
  @param  DriverHandle           Handle to be returned\r
\r
  @retval EFI_SUCCESS            Handle destroy success.\r
  @retval EFI_OUT_OF_RESOURCES   Not enough memory.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibCreateHiiDriverHandle (\r
  OUT EFI_HANDLE               *DriverHandle\r
  )\r
;\r
\r
/**\r
  Destroy the Driver Handle created by CreateHiiDriverHandle().\r
\r
  If no Device Path protocol is installed on the DriverHandle, then ASSERT.\r
  If this Device Path protocol is failed to be uninstalled, then ASSERT.\r
\r
  @param  DriverHandle           Handle returned by CreateHiiDriverHandle()\r
\r
\r
**/\r
VOID\r
EFIAPI\r
HiiLibDestroyHiiDriverHandle (\r
  IN EFI_HANDLE                 DriverHandle\r
  )\r
;\r
\r
\r
#endif\r
Commit	Line	Data
9226efe5	1	/** @file\r
	2	This library includes the APIs that is specific to EDK II's implementation.\r
	3	It extended the UEFI Specification to define GUIDed device path.\r
	4	\r
	5	Copyright (c) 2008, Intel Corporation \r
	6	All rights reserved. This program and the accompanying materials \r
	7	are licensed and made available under the terms and conditions of the BSD License \r
	8	which accompanies this distribution. The full text of the license may be found at \r
	9	http://opensource.org/licenses/bsd-license.php \r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef __EXTENDED_HII_LIB_H__\r
	17	#define __EXTENDED_HII_LIB_H__\r
	18	\r
	19	/**\r
	20	The HII driver handle passed in for HiiDatabase.NewPackageList() requires\r
	21	that there should be DevicePath Protocol installed on it.\r
	22	This routine create a virtual Driver Handle by installing a vendor device\r
	23	path on it, so as to use it to invoke HiiDatabase.NewPackageList().\r
	24	The Device Path created is a Vendor Device Path specific to Intel's implemenation.\r
	25	\r
	26	@param DriverHandle Handle to be returned\r
	27	\r
	28	@retval EFI_SUCCESS Handle destroy success.\r
	29	@retval EFI_OUT_OF_RESOURCES Not enough memory.\r
	30	\r
	31	**/\r
	32	EFI_STATUS\r
	33	EFIAPI\r
	34	HiiLibCreateHiiDriverHandle (\r
	35	OUT EFI_HANDLE *DriverHandle\r
	36	)\r
	37	;\r
	38	\r
	39	/**\r
	40	Destroy the Driver Handle created by CreateHiiDriverHandle().\r
	41	\r
	42	If no Device Path protocol is installed on the DriverHandle, then ASSERT.\r
	43	If this Device Path protocol is failed to be uninstalled, then ASSERT.\r
	44	\r
	45	@param DriverHandle Handle returned by CreateHiiDriverHandle()\r
	46	\r
	47	\r
	48	**/\r
	49	VOID\r
	50	EFIAPI\r
	51	HiiLibDestroyHiiDriverHandle (\r
	52	IN EFI_HANDLE DriverHandle\r
	53	)\r
	54	;\r
	55	\r
	56	\r
	57	#endif\r