instance.\r
If protocol of gEfiHiiProtocolGuid is not installed, then ASSERT().\r
\r
- @param ImageHandle The image handle of driver module who use this library \r
- instance.\r
+ @param ImageHandle The image handle of driver module who use this library instance.\r
@param SystemTable Pointer to the EFI System Table.\r
+ \r
@retval EFI_SUCCESS library constuctor always success.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FrameworkHiiLibConstructor (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
{\r
- EFI_STATUS Status;\r
+ EFI_STATUS Status;\r
\r
Status = gBS->LocateProtocol (\r
- &gEfiHiiProtocolGuid,\r
- NULL,\r
- (VOID **) &mHii\r
- );\r
+ &gEfiHiiProtocolGuid,\r
+ NULL,\r
+ (VOID **) &mHii\r
+ );\r
ASSERT_EFI_ERROR (Status);\r
ASSERT (mHii != NULL);\r
\r
@param Guid Given GUID of a HII package list.\r
@param Marker Package's content list.\r
\r
- @return pointer to new created HII package list.\r
+ @return pointer to new created HII package list.\r
**/\r
EFI_HII_PACKAGES *\r
InternalPreparePackages (\r
- IN UINTN NumberOfPackages,\r
- IN CONST EFI_GUID *Guid OPTIONAL,\r
- IN VA_LIST Marker\r
+ IN UINTN NumberOfPackages,\r
+ IN CONST EFI_GUID *Guid OPTIONAL,\r
+ IN VA_LIST Marker\r
)\r
{\r
- EFI_HII_PACKAGES *HiiPackages;\r
- VOID **Package;\r
- UINTN Index;\r
+ EFI_HII_PACKAGES *HiiPackages;\r
+ VOID **Package;\r
+ UINTN Index;\r
\r
ASSERT (NumberOfPackages > 0);\r
\r
- HiiPackages = AllocateZeroPool (sizeof (EFI_HII_PACKAGES) + NumberOfPackages * sizeof (VOID *));\r
+ HiiPackages = AllocateZeroPool (sizeof (EFI_HII_PACKAGES) + NumberOfPackages * sizeof (VOID *));\r
ASSERT (HiiPackages != NULL);\r
\r
HiiPackages->GuidId = (EFI_GUID *) Guid;\r
}\r
\r
return HiiPackages;\r
-\r
}\r
\r
/**\r
\r
@param NumberOfPackages The number of HII packages to prepare.\r
@param Guid Package GUID.\r
- @Param ... The variable argument list of package pointers.\r
+ @param ... The variable argument list of package pointers.\r
\r
- @return The allocated and initialized packages.\r
+ @return The allocated and initialized packages.\r
**/\r
EFI_HII_PACKAGES *\r
EFIAPI\r
PreparePackages (\r
- IN UINTN NumberOfPackages,\r
- IN CONST EFI_GUID *Guid OPTIONAL,\r
+ IN UINTN NumberOfPackages,\r
+ IN CONST EFI_GUID *Guid OPTIONAL,\r
...\r
)\r
{\r
- VA_LIST Args;\r
+ VA_LIST Args;\r
\r
VA_START (Args, Guid);\r
-\r
return InternalPreparePackages (NumberOfPackages, Guid, Args);\r
}\r
\r
Then, EFI_HII_PACKAGE_LIST will be register to the default System HII Database. The\r
Handle to the newly registered Package List is returned throught HiiHandle.\r
\r
- @param NumberOfPackages The number of HII packages to register.\r
- @param GuidId Package List GUID ID.\r
- @param DriverHandle The pointer of driver handle\r
- @param HiiHandle The ID used to retrieve the Package List later.\r
- @param ... The variable argument list describing all HII Package.\r
+ @param NumberOfPackages The number of HII packages to register.\r
+ @param GuidId Package List GUID ID.\r
+ @param DriverHandle The pointer of driver handle\r
+ @param HiiHandle The ID used to retrieve the Package List later.\r
+ @param ... The variable argument list describing all HII Package.\r
\r
- @return\r
- The allocated and initialized packages.\r
+ @return The allocated and initialized packages.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibAddPackages (\r
- IN UINTN NumberOfPackages,\r
- IN CONST EFI_GUID *GuidId,\r
- IN EFI_HANDLE DriverHandle, OPTIONAL\r
- OUT EFI_HII_HANDLE *HiiHandle, OPTIONAL\r
+ IN UINTN NumberOfPackages,\r
+ IN CONST EFI_GUID *GuidId,\r
+ IN EFI_HANDLE DriverHandle, OPTIONAL\r
+ OUT EFI_HII_HANDLE *HiiHandle, \r
...\r
)\r
{\r
- VA_LIST Args;\r
- EFI_HII_PACKAGES *FrameworkHiiPacages;\r
- FRAMEWORK_EFI_HII_HANDLE FrameworkHiiHandle;\r
- EFI_STATUS Status;\r
-\r
+ VA_LIST Args;\r
+ EFI_HII_PACKAGES *FrameworkHiiPacages;\r
+ FRAMEWORK_EFI_HII_HANDLE FrameworkHiiHandle;\r
+ EFI_STATUS Status;\r
\r
VA_START (Args, HiiHandle);\r
- FrameworkHiiPacages = InternalPreparePackages (NumberOfPackages, GuidId, Args);\r
\r
- Status = mHii->NewPack (mHii, FrameworkHiiPacages, &FrameworkHiiHandle);\r
+ FrameworkHiiPacages = InternalPreparePackages (NumberOfPackages, GuidId, Args);\r
+ Status = mHii->NewPack (mHii, FrameworkHiiPacages, &FrameworkHiiHandle);\r
if (HiiHandle != NULL) {\r
if (EFI_ERROR (Status)) {\r
*HiiHandle = NULL;\r
If HiiHandle is NULL, then ASSERT.\r
If HiiHandle is not a valid EFI_HII_HANDLE in the default HII database, then ASSERT.\r
\r
- @param HiiHandle The handle that was previously registered to the data base that is requested for removal.\r
- List later.\r
+ @param HiiHandle The handle that was previously registered to the data base that is requested for removal.\r
\r
- @return VOID\r
+ @return VOID\r
**/\r
VOID\r
EFIAPI\r
HiiLibRemovePackages (\r
- IN EFI_HII_HANDLE HiiHandle\r
+ IN EFI_HII_HANDLE HiiHandle\r
)\r
{\r
- EFI_STATUS Status;\r
+ EFI_STATUS Status;\r
\r
Status = mHii->RemovePack (mHii, (FRAMEWORK_EFI_HII_HANDLE) (UINTN) HiiHandle);\r
ASSERT_EFI_ERROR (Status);\r
}\r
\r
-\r
/**\r
This function adds the string into String Package of each language.\r
\r
EFI_STATUS\r
EFIAPI\r
HiiLibNewString (\r
- IN EFI_HII_HANDLE PackageList,\r
- OUT EFI_STRING_ID *StringId,\r
- IN CONST EFI_STRING String\r
+ IN EFI_HII_HANDLE PackageList,\r
+ OUT EFI_STRING_ID *StringId,\r
+ IN CONST EFI_STRING String\r
)\r
{\r
- FRAMEWORK_EFI_HII_HANDLE FrameworkHiiHandle;\r
- EFI_STATUS Status;\r
+ FRAMEWORK_EFI_HII_HANDLE FrameworkHiiHandle;\r
+ EFI_STATUS Status;\r
\r
FrameworkHiiHandle = (FRAMEWORK_EFI_HII_HANDLE) (UINTN) PackageList;\r
Status = mHii->NewString (\r
- mHii,\r
- NULL,\r
- FrameworkHiiHandle,\r
- StringId,\r
- String\r
- );\r
+ mHii,\r
+ NULL,\r
+ FrameworkHiiHandle,\r
+ StringId,\r
+ String\r
+ );\r
\r
return Status;\r
}\r
\r
@retval EFI_SUCCESS Operation is successful.\r
@retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
-\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibGetStringFromToken (\r
- IN EFI_GUID *ProducerGuid,\r
- IN EFI_STRING_ID StringId,\r
- OUT EFI_STRING *String\r
+ IN EFI_GUID *ProducerGuid,\r
+ IN EFI_STRING_ID StringId,\r
+ OUT EFI_STRING *String\r
)\r
{\r
return EFI_SUCCESS; \r
EFI_STATUS\r
EFIAPI\r
HiiLibGetStringFromHandle (\r
- IN EFI_HII_HANDLE PackageList,\r
- IN EFI_STRING_ID StringId,\r
- OUT EFI_STRING *String\r
+ IN EFI_HII_HANDLE PackageList,\r
+ IN EFI_STRING_ID StringId,\r
+ OUT EFI_STRING *String\r
)\r
{\r
return EFI_SUCCESS;\r
The implement set DriverHandle to NULL simpliy to let \r
handle manager create a default new handle.\r
\r
- @param[out] DriverHandle the pointer of driver handle\r
- @return always successful.\r
+ @param DriverHandle The pointer of driver handle\r
+ \r
+ @return Always success.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiLibCreateHiiDriverHandle (\r
- OUT EFI_HANDLE *DriverHandle\r
+ OUT EFI_HANDLE *DriverHandle\r
)\r
{\r
//\r