HiiUtilityLib.c File Reference

#include "HiiInternal.h"

Go to the source code of this file.

Functions
EFI_STATUS	CreateFormSetFromHiiHandle (IN EFI_HII_HANDLE Handle, IN OUT EFI_GUID *FormSetGuid, OUT HII_FORMSET *FormSet)
VOID	InitializeFormSet (IN OUT HII_FORMSET *FormSet)
VOID	DestroyFormSet (IN OUT HII_FORMSET *FormSet)
EFI_STATUS	SubmitForm (IN HII_FORMSET *FormSet, IN HII_FORM *Form)
EFI_STATUS	SetQuestionValue (IN HII_FORMSET *FormSet, IN HII_FORM *Form, IN OUT HII_STATEMENT *Question, IN HII_STATEMENT_VALUE *QuestionValue)
HII_STATEMENT_VALUE *	RetrieveQuestion (IN HII_FORMSET *FormSet, IN HII_FORM *Form, IN OUT HII_STATEMENT *Question)

Detailed Description

Implementation of HII utility library.

Copyright (c) 2019, Intel Corporation. All rights reserved.
(C) Copyright 2021 Hewlett Packard Enterprise Development LP
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file HiiUtilityLib.c.

Function Documentation

CreateFormSetFromHiiHandle()

EFI_STATUS CreateFormSetFromHiiHandle	(	IN EFI_HII_HANDLE	Handle,
		IN OUT EFI_GUID *	FormSetGuid,
		OUT HII_FORMSET *	FormSet
	)

Initialize the internal data structure of a FormSet.

Parameters

Handle	PackageList Handle
FormSetGuid	On input, GUID or class GUID of a formset. If not specified (NULL or zero GUID), take the first FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID found in package list. On output, GUID of the formset found(if not NULL).
FormSet	FormSet data structure.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_NOT_FOUND	The specified FormSet could not be found.

Definition at line 30 of file HiiUtilityLib.c.

DestroyFormSet()

VOID DestroyFormSet

(

IN OUT HII_FORMSET *

FormSet

)

Free resources allocated for a FormSet.

Parameters

[in,out]

FormSet

Pointer of the FormSet

Definition at line 165 of file HiiUtilityLib.c.

InitializeFormSet()

VOID InitializeFormSet

(

IN OUT HII_FORMSET *

FormSet

)

Initialize a Formset and get current setting for Questions.

Parameters

FormSet

FormSet data structure.

Definition at line 114 of file HiiUtilityLib.c.

RetrieveQuestion()

HII_STATEMENT_VALUE * RetrieveQuestion	(	IN HII_FORMSET *	FormSet,
		IN HII_FORM *	Form,
		IN OUT HII_STATEMENT *	Question
	)

Get Question's current Value from storage.

Parameters

[in]	FormSet	FormSet data structure.
[in]	Form	Form data structure.
[in,out]	Question	Question to be initialized.

Returns

the current Question Value in storage if success.

NULL if Question is not found or any error occurs.

Definition at line 532 of file HiiUtilityLib.c.

SetQuestionValue()

EFI_STATUS SetQuestionValue	(	IN HII_FORMSET *	FormSet,
		IN HII_FORM *	Form,
		IN OUT HII_STATEMENT *	Question,
		IN HII_STATEMENT_VALUE *	QuestionValue
	)

Save Question Value to the memory, but not to storage.

Parameters

[in]	FormSet	FormSet data structure.
[in]	Form	Form data structure.
[in,out]	Question	Pointer to the Question.
[in]	QuestionValue	New Question Value to be set.

Return values

EFI_SUCCESS	The question value has been set successfully.
EFI_INVALID_PARAMETER	One or more parameters are invalid.

Definition at line 325 of file HiiUtilityLib.c.

SubmitForm()

EFI_STATUS SubmitForm	(	IN HII_FORMSET *	FormSet,
		IN HII_FORM *	Form
	)

Submit data for a form.

Parameters

[in]	FormSet	FormSet which contains the Form.
[in]	Form	Form to submit.

Return values

EFI_SUCCESS	The function completed successfully.
Others	Other errors occur.

Definition at line 242 of file HiiUtilityLib.c.