#include <Protocol/DisplayProtocol.h>
#include <Protocol/HiiConfigAccess.h>

Data Structures
struct	HII_NAME_VALUE_NODE

union	HII_VAR_STORE_INFO

struct	HII_FORMSET_STORAGE

union	HII_EXPRESSION_OPCODE_EXTRA

struct	HII_EXPRESSION_CONSTANT

struct	HII_DEPENDENCY_DUP

struct	HII_DEPENDENCY_EQ_ID_VAL

struct	HII_DEPENDENCY_EQ_ID_ID

struct	HII_DEPENDENCY_EQ_ID_VAL_LIST

struct	HII_DEPENDENCY_QUESTION_REF1

struct	HII_DEPENDENCY_RULE_REF

struct	HII_DEPENDENCY_STRING_REF1

struct	HII_DEPENDENCY_THIS

struct	HII_DEPENDENCY_SECURITY

struct	HII_DEPENDENCY_GET

struct	HII_DEPENDENCY_LENGTH

struct	HII_DEPENDENCY_BITWISE_NOT

struct	HII_DEPENDENCY_STRING_REF2

struct	HII_DEPENDENCY_QUESTION_REF2

struct	HII_DEPENDENCY_QUESTION_REF3

struct	HII_DEPENDENCY_TO_BOOLEAN

struct	HII_DEPENDENCY_TO_STRING

struct	HII_DEPENDENCY_TO_UINT

struct	HII_DEPENDENCY_TO_UPPER

struct	HII_DEPENDENCY_TO_LOWER

struct	HII_DEPENDENCY_SET

struct	HII_DEPENDENCY_NOT

struct	HII_DEPENDENCY_CATENATE

struct	HII_DEPENDENCY_MATCH

struct	HII_DEPENDENCY_MATCH2

struct	HII_DEPENDENCY_MULT

struct	HII_DEPENDENCY_DIV

struct	HII_DEPENDENCY_MOD

struct	HII_DEPENDENCY_ADD

struct	HII_DEPENDENCY_SUBTRACT

struct	HII_DEPENDENCY_SHIFT_LEFT

struct	HII_DEPENDENCY_SHIFT_RIGHT

struct	HII_DEPENDENCY_GREATER_THAN

struct	HII_DEPENDENCY_GREATER_EQUAL

struct	HII_DEPENDENCY_LESS_THAN

struct	HII_DEPENDENCY_LESS_EQUAL

struct	HII_DEPENDENCY_EQUAL

struct	HII_DEPENDENCY_NOT_EQUAL

struct	HII_DEPENDENCY_BITWISE_AND

struct	HII_DEPENDENCY_BITWISE_OR

struct	HII_DEPENDENCY_AND

struct	HII_DEPENDENCY_OR

struct	HII_DEPENDENCY_CONDITIONAL

struct	HII_DEPENDENCY_FIND

struct	HII_DEPENDENCY_MID

struct	HII_DEPENDENCY_TOKEN

struct	HII_DEPENDENCY_SPAN

struct	HII_DEPENDENCY_EXPRESSION_PAIR

struct	HII_DEPENDENCY_MAP

union	_HII_DEPENDENCY_EXPRESSION

struct	HII_EXPRESSION_OPCODE

struct	HII_WARNING_IF_DATA

union	HII_EXTRA_DATA

struct	HII_EXPRESSION

struct	HII_EXPRESSION_LIST

struct	HII_STATEMENT_VALUE

struct	HII_QUESTION_DEFAULT

struct	HII_QUESTION_OPTION

struct	HII_FORMSET_DEFAULTSTORE

union	HII_STATEMENT_EXTRA

struct	_HII_STATEMENT

struct	HII_FORM

struct	HII_FORMSET

Macros
#define	EFI_HII_EXPRESSION_INCONSISTENT_IF 0

#define	EFI_HII_EXPRESSION_NO_SUBMIT_IF 1

#define	EFI_HII_EXPRESSION_GRAY_OUT_IF 2

#define	EFI_HII_EXPRESSION_SUPPRESS_IF 3

#define	EFI_HII_EXPRESSION_DISABLE_IF 4

#define	EFI_HII_EXPRESSION_VALUE 5

#define	EFI_HII_EXPRESSION_RULE 6

#define	EFI_HII_EXPRESSION_READ 7

#define	EFI_HII_EXPRESSION_WRITE 8

#define	EFI_HII_EXPRESSION_WARNING_IF 9

#define	EFI_HII_VARSTORE_BUFFER 0

#define	EFI_HII_VARSTORE_NAME_VALUE 1

#define	EFI_HII_VARSTORE_EFI_VARIABLE 2

#define	EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER 3

#define	HII_NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')

#define	HII_NAME_VALUE_NODE_FROM_LINK(a) CR (a, HII_NAME_VALUE_NODE, Link, HII_NAME_VALUE_NODE_SIGNATURE)

#define	HII_STORAGE_SIGNATURE SIGNATURE_32 ('B', 'S', 'T', 'G')

#define	HII_STORAGE_FROM_LINK(a) CR (a, HII_FORMSET_STORAGE, Link, HII_STORAGE_SIGNATURE)

#define	HII_EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')

#define	HII_EXPRESSION_OPCODE_FROM_LINK(a) CR (a, HII_EXPRESSION_OPCODE, Link, HII_EXPRESSION_OPCODE_SIGNATURE)

#define	HII_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')

#define	HII_EXPRESSION_FROM_LINK(a) CR (a, HII_EXPRESSION, Link, HII_EXPRESSION_SIGNATURE)

#define	HII_EXPRESSION_LIST_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'R')

#define	HII_QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')

#define	HII_QUESTION_DEFAULT_FROM_LINK(a) CR (a, HII_QUESTION_DEFAULT, Link, HII_QUESTION_DEFAULT_SIGNATURE)

#define	HII_QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')

#define	HII_QUESTION_OPTION_FROM_LINK(a) CR (a, HII_QUESTION_OPTION, Link, HII_QUESTION_OPTION_SIGNATURE)

#define	HII_FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')

#define	HII_FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, HII_FORMSET_DEFAULTSTORE, Link, HII_FORMSET_DEFAULTSTORE_SIGNATURE)

#define	HII_STATEMENT_SIGNATURE SIGNATURE_32 ('H', 'S', 'T', 'A')

#define	HII_STATEMENT_FROM_LINK(a) CR (a, HII_STATEMENT, Link, HII_STATEMENT_SIGNATURE)

#define	STANDARD_MAP_FORM_TYPE 0x01

#define	HII_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')

#define	HII_FORM_FROM_LINK(a) CR (a, HII_FORM, Link, HII_FORM_SIGNATURE)

#define	HII_FORMSET_SIGNATURE SIGNATURE_32 ('H', 'I', 'F', 'S')

#define	HII_FORMSET_FROM_LINK(a) CR (a, HII_FORMSET, Link, HII_FORMSET_SIGNATURE)

Typedefs
typedef union _HII_DEPENDENCY_EXPRESSION	HII_DEPENDENCY_EXPRESSION

typedef struct _HII_STATEMENT	HII_STATEMENT

Enumerations
enum	EXPRESS_RESULT { ExpressFalse = 0 , ExpressGrayOut , ExpressSuppress , ExpressDisable , ExpressFalse = 0 , ExpressGrayOut , ExpressSuppress , ExpressDisable }

enum	EXPRESS_LEVEL { ExpressNone = 0 , ExpressForm , ExpressStatement , ExpressOption , ExpressNone = 0 , ExpressForm , ExpressStatement , ExpressOption }

enum	GET_SET_QUESTION_VALUE_WITH { GetSetValueWithEditBuffer = 0 , GetSetValueWithBuffer , GetSetValueWithHiiDriver , GetSetValueWithBothBuffer , GetSetValueWithMax , GetSetValueWithBuffer = 0 , GetSetValueWithHiiDriver , GetSetValueWithBoth , GetSetValueWithMax }

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	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)

EFI_STATUS	GetQuestionValue (IN HII_FORMSET FormSet, IN HII_FORM Form, IN OUT HII_STATEMENT *Question, IN GET_SET_QUESTION_VALUE_WITH GetValueFrom)

EFI_STATUS	SubmitForm (IN HII_FORMSET FormSet, IN HII_FORM Form)

EFI_STATUS	EvaluateHiiExpression (IN HII_FORMSET FormSet, IN HII_FORM Form, IN OUT HII_EXPRESSION *Expression)

EFI_STATUS	GetHiiExpressionDependency (IN HII_EXPRESSION *Expression)

EFI_STATUS	GetQuestionDefault (IN HII_FORMSET FormSet, IN HII_FORM Form, IN HII_STATEMENT Question, IN UINT16 DefaultId, OUT HII_STATEMENT_VALUE DefaultValue)

EXPRESS_RESULT	EvaluateExpressionList (IN HII_EXPRESSION_LIST ExpList, IN BOOLEAN Evaluate, IN HII_FORMSET FormSet OPTIONAL, IN HII_FORM *Form OPTIONAL)

Detailed Description

Definitions of RedfishPlatformConfigLib.

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

Definition in file HiiUtilityLib.h.

Macro Definition Documentation

◆ EFI_HII_EXPRESSION_DISABLE_IF

#define EFI_HII_EXPRESSION_DISABLE_IF 4

Definition at line 25 of file HiiUtilityLib.h.

◆ EFI_HII_EXPRESSION_GRAY_OUT_IF

#define EFI_HII_EXPRESSION_GRAY_OUT_IF 2

Definition at line 23 of file HiiUtilityLib.h.

◆ EFI_HII_EXPRESSION_INCONSISTENT_IF

#define EFI_HII_EXPRESSION_INCONSISTENT_IF 0

Definition at line 21 of file HiiUtilityLib.h.

◆ EFI_HII_EXPRESSION_NO_SUBMIT_IF

#define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1

Definition at line 22 of file HiiUtilityLib.h.

◆ EFI_HII_EXPRESSION_READ

#define EFI_HII_EXPRESSION_READ 7

Definition at line 28 of file HiiUtilityLib.h.

◆ EFI_HII_EXPRESSION_RULE

#define EFI_HII_EXPRESSION_RULE 6

Definition at line 27 of file HiiUtilityLib.h.

◆ EFI_HII_EXPRESSION_SUPPRESS_IF

#define EFI_HII_EXPRESSION_SUPPRESS_IF 3

Definition at line 24 of file HiiUtilityLib.h.

◆ EFI_HII_EXPRESSION_VALUE

#define EFI_HII_EXPRESSION_VALUE 5

Definition at line 26 of file HiiUtilityLib.h.

◆ EFI_HII_EXPRESSION_WARNING_IF

#define EFI_HII_EXPRESSION_WARNING_IF 9

Definition at line 30 of file HiiUtilityLib.h.

◆ EFI_HII_EXPRESSION_WRITE

#define EFI_HII_EXPRESSION_WRITE 8

Definition at line 29 of file HiiUtilityLib.h.

◆ EFI_HII_VARSTORE_BUFFER

#define EFI_HII_VARSTORE_BUFFER 0

Definition at line 32 of file HiiUtilityLib.h.

◆ EFI_HII_VARSTORE_EFI_VARIABLE

#define EFI_HII_VARSTORE_EFI_VARIABLE 2

Definition at line 34 of file HiiUtilityLib.h.

◆ EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER

#define EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER 3

Definition at line 35 of file HiiUtilityLib.h.

◆ EFI_HII_VARSTORE_NAME_VALUE

#define EFI_HII_VARSTORE_NAME_VALUE 1

Definition at line 33 of file HiiUtilityLib.h.

◆ HII_EXPRESSION_FROM_LINK

#define HII_EXPRESSION_FROM_LINK ( a ) CR (a, HII_EXPRESSION, Link, HII_EXPRESSION_SIGNATURE)

Definition at line 752 of file HiiUtilityLib.h.

◆ HII_EXPRESSION_LIST_SIGNATURE

#define HII_EXPRESSION_LIST_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'R')

Definition at line 763 of file HiiUtilityLib.h.

◆ HII_EXPRESSION_OPCODE_FROM_LINK

#define HII_EXPRESSION_OPCODE_FROM_LINK ( a ) CR (a, HII_EXPRESSION_OPCODE, Link, HII_EXPRESSION_OPCODE_SIGNATURE)

Definition at line 718 of file HiiUtilityLib.h.

◆ HII_EXPRESSION_OPCODE_SIGNATURE

#define HII_EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')

Definition at line 717 of file HiiUtilityLib.h.

◆ HII_EXPRESSION_SIGNATURE

#define HII_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')

Definition at line 751 of file HiiUtilityLib.h.

◆ HII_FORM_FROM_LINK

#define HII_FORM_FROM_LINK ( a ) CR (a, HII_FORM, Link, HII_FORM_SIGNATURE)

Definition at line 958 of file HiiUtilityLib.h.

◆ HII_FORM_SIGNATURE

#define HII_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')

Definition at line 957 of file HiiUtilityLib.h.

◆ HII_FORMSET_DEFAULTSTORE_FROM_LINK

#define HII_FORMSET_DEFAULTSTORE_FROM_LINK ( a ) CR (a, HII_FORMSET_DEFAULTSTORE, Link, HII_FORMSET_DEFAULTSTORE_SIGNATURE)

Definition at line 831 of file HiiUtilityLib.h.

◆ HII_FORMSET_DEFAULTSTORE_SIGNATURE

#define HII_FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')

Definition at line 830 of file HiiUtilityLib.h.

◆ HII_FORMSET_FROM_LINK

#define HII_FORMSET_FROM_LINK ( a ) CR (a, HII_FORMSET, Link, HII_FORMSET_SIGNATURE)

Definition at line 991 of file HiiUtilityLib.h.

◆ HII_FORMSET_SIGNATURE

#define HII_FORMSET_SIGNATURE SIGNATURE_32 ('H', 'I', 'F', 'S')

Definition at line 990 of file HiiUtilityLib.h.

◆ HII_NAME_VALUE_NODE_FROM_LINK

#define HII_NAME_VALUE_NODE_FROM_LINK ( a ) CR (a, HII_NAME_VALUE_NODE, Link, HII_NAME_VALUE_NODE_SIGNATURE)

Definition at line 48 of file HiiUtilityLib.h.

◆ HII_NAME_VALUE_NODE_SIGNATURE

#define HII_NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')

Definition at line 47 of file HiiUtilityLib.h.

◆ HII_QUESTION_DEFAULT_FROM_LINK

#define HII_QUESTION_DEFAULT_FROM_LINK ( a ) CR (a, HII_QUESTION_DEFAULT, Link, HII_QUESTION_DEFAULT_SIGNATURE)

Definition at line 796 of file HiiUtilityLib.h.

◆ HII_QUESTION_DEFAULT_SIGNATURE

#define HII_QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')

Definition at line 795 of file HiiUtilityLib.h.

◆ HII_QUESTION_OPTION_FROM_LINK

#define HII_QUESTION_OPTION_FROM_LINK ( a ) CR (a, HII_QUESTION_OPTION, Link, HII_QUESTION_OPTION_SIGNATURE)

Definition at line 817 of file HiiUtilityLib.h.

◆ HII_QUESTION_OPTION_SIGNATURE

#define HII_QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')

Definition at line 798 of file HiiUtilityLib.h.

◆ HII_STATEMENT_FROM_LINK

#define HII_STATEMENT_FROM_LINK ( a ) CR (a, HII_STATEMENT, Link, HII_STATEMENT_SIGNATURE)

Definition at line 930 of file HiiUtilityLib.h.

◆ HII_STATEMENT_SIGNATURE

#define HII_STATEMENT_SIGNATURE SIGNATURE_32 ('H', 'S', 'T', 'A')

Definition at line 929 of file HiiUtilityLib.h.

◆ HII_STORAGE_FROM_LINK

#define HII_STORAGE_FROM_LINK ( a ) CR (a, HII_FORMSET_STORAGE, Link, HII_STORAGE_SIGNATURE)

Definition at line 99 of file HiiUtilityLib.h.

◆ HII_STORAGE_SIGNATURE

#define HII_STORAGE_SIGNATURE SIGNATURE_32 ('B', 'S', 'T', 'G')

Definition at line 98 of file HiiUtilityLib.h.

◆ STANDARD_MAP_FORM_TYPE

#define STANDARD_MAP_FORM_TYPE 0x01

Form

Definition at line 935 of file HiiUtilityLib.h.

Typedef Documentation

◆ HII_DEPENDENCY_EXPRESSION

typedef union _HII_DEPENDENCY_EXPRESSION HII_DEPENDENCY_EXPRESSION

Definition at line 165 of file HiiUtilityLib.h.

◆ HII_STATEMENT

typedef struct _HII_STATEMENT HII_STATEMENT

Statement (Question)

Definition at line 871 of file HiiUtilityLib.h.

Enumeration Type Documentation

◆ EXPRESS_LEVEL

enum EXPRESS_LEVEL

Definition of EXPRESS_LEVEL

Definition at line 114 of file HiiUtilityLib.h.

◆ EXPRESS_RESULT

enum EXPRESS_RESULT

Definition of EXPRESS_RESULT

Definition at line 104 of file HiiUtilityLib.h.

◆ GET_SET_QUESTION_VALUE_WITH

enum GET_SET_QUESTION_VALUE_WITH

Get/set question value from/to.

Enumerator
GetSetValueWithBuffer	Get/Set question value from/to buffer in the storage.
GetSetValueWithHiiDriver	Get/Set question value from/to hii driver.
GetSetValueWithBoth	Compare the editbuffer with buffer for this question, not use the question value.
GetSetValueWithMax	Invalid value.

Definition at line 996 of file HiiUtilityLib.h.

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

[in]	Handle	PackageList Handle
[in,out]	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).
[out]	FormSet	FormSet data structure.

Return values

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

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.

◆ EvaluateExpressionList()

EXPRESS_RESULT EvaluateExpressionList	(	IN HII_EXPRESSION_LIST *	ExpList,
		IN BOOLEAN	Evaluate,
		IN HII_FORMSET *FormSet	OPTIONAL,
		IN HII_FORM *Form	OPTIONAL
	)

Return the result of the expression list. Check the expression list and return the highest priority express result. Priority: DisableIf > SuppressIf > GrayOutIf > FALSE

Parameters

[in]	ExpList	The input expression list.
[in]	Evaluate	Whether need to evaluate the expression first.
[in]	FormSet	FormSet associated with this expression.
[in]	Form	Form associated with this expression.

Return values

EXPRESS_RESULT Return the higher priority express result. DisableIf > SuppressIf > GrayOutIf > FALSE

Definition at line 1380 of file HiiExpression.c.

◆ EvaluateHiiExpression()

EFI_STATUS EvaluateHiiExpression	(	IN HII_FORMSET *	FormSet,
		IN HII_FORM *	Form,
		IN OUT HII_EXPRESSION *	Expression
	)

Evaluate the result of a HII expression.

If Expression is NULL, then ASSERT.

Parameters

[in]	FormSet	FormSet associated with this expression.
[in]	Form	Form associated with this expression.
[in,out]	Expression	Expression to be evaluated.

Return values

EFI_SUCCESS	The expression evaluated successfully
EFI_NOT_FOUND	The Question which referenced by a QuestionId could not be found.
EFI_OUT_OF_RESOURCES	There is not enough system memory to grow the stack.
EFI_ACCESS_DENIED	The pop operation underflowed the stack
EFI_INVALID_PARAMETER	Syntax error with the Expression

Evaluate the result of a HII expression.

If Expression is NULL, then ASSERT.

Parameters

[in]	FormSet	FormSet associated with this expression.
[in]	Form	Form associated with this expression.
[in,out]	Expression	Expression to be evaluated.

Return values

EFI_SUCCESS	The expression evaluated successfully.
EFI_NOT_FOUND	The Question which referenced by a QuestionId could not be found.
EFI_OUT_OF_RESOURCES	There is not enough system memory to grow the stack.
EFI_ACCESS_DENIED	The pop operation underflowed the stack.
EFI_INVALID_PARAMETER	Syntax error with the Expression.
EFI_INVALID_PARAMETER	Formset, Form or Expression is NULL.

Definition at line 3912 of file HiiUtilityInternal.c.

◆ GetHiiExpressionDependency()

EFI_STATUS GetHiiExpressionDependency ( IN HII_EXPRESSION * Expression )

Retrieve dependencies within an expression. These dependencies can express how this expression will be evaluated.

Parameters

[in] Expression Expression to retrieve dependencies.

Return values

EFI_SUCCESS	The dependencies were successfully retrieved.
EFI_OUT_OF_RESOURCES	There is not enough system memory.

◆ GetQuestionDefault()

EFI_STATUS GetQuestionDefault	(	IN HII_FORMSET *	FormSet,
		IN HII_FORM *	Form,
		IN HII_STATEMENT *	Question,
		IN UINT16	DefaultId,
		OUT HII_STATEMENT_VALUE *	DefaultValue
	)

Get default value of question.

Parameters

[in]	FormSet	The form set.
[in]	Form	The form.
[in]	Question	The question.
[in]	DefaultId	The Class of the default.
[out]	DefaultValue	The default value of given question.

Return values

EFI_SUCCESS Question is reset to default value.

Definition at line 5425 of file HiiUtilityInternal.c.

◆ GetQuestionValue()

EFI_STATUS GetQuestionValue	(	IN HII_FORMSET *	FormSet,
		IN HII_FORM *	Form,
		IN OUT HII_STATEMENT *	Question,
		IN GET_SET_QUESTION_VALUE_WITH	GetValueFrom
	)

Get Question's current Value.

Parameters

[in]	FormSet	FormSet data structure.
[in]	Form	Form data structure.
[out]	Question	Question to be initialized.
[in]	GetValueFrom	Where to get value, may from editbuffer, buffer or hii driver.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Formset, Form or Question is NULL.

Get Question's current Value.

Parameters

[in]	FormSet	FormSet data structure.
[in]	Form	Form data structure.
[in,out]	Question	Question to be initialized.
[in]	GetValueFrom	Where to get value, may from editbuffer, buffer or hii driver.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Formset, Form or Question is NULL.

Definition at line 1460 of file HiiUtilityInternal.c.

◆ InitializeFormSet()

VOID InitializeFormSet ( IN OUT HII_FORMSET * FormSet )

Initialize a Formset and get current setting for Questions.

Parameters

[in,out] FormSet FormSet data structure.

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.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ EFI_HII_EXPRESSION_DISABLE_IF

◆ EFI_HII_EXPRESSION_GRAY_OUT_IF

◆ EFI_HII_EXPRESSION_INCONSISTENT_IF

◆ EFI_HII_EXPRESSION_NO_SUBMIT_IF

◆ EFI_HII_EXPRESSION_READ

◆ EFI_HII_EXPRESSION_RULE

◆ EFI_HII_EXPRESSION_SUPPRESS_IF

◆ EFI_HII_EXPRESSION_VALUE

◆ EFI_HII_EXPRESSION_WARNING_IF

◆ EFI_HII_EXPRESSION_WRITE

◆ EFI_HII_VARSTORE_BUFFER

◆ EFI_HII_VARSTORE_EFI_VARIABLE

◆ EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER

◆ EFI_HII_VARSTORE_NAME_VALUE

◆ HII_EXPRESSION_FROM_LINK

◆ HII_EXPRESSION_LIST_SIGNATURE

◆ HII_EXPRESSION_OPCODE_FROM_LINK

◆ HII_EXPRESSION_OPCODE_SIGNATURE

◆ HII_EXPRESSION_SIGNATURE

◆ HII_FORM_FROM_LINK

◆ HII_FORM_SIGNATURE

◆ HII_FORMSET_DEFAULTSTORE_FROM_LINK

◆ HII_FORMSET_DEFAULTSTORE_SIGNATURE

◆ HII_FORMSET_FROM_LINK

◆ HII_FORMSET_SIGNATURE

◆ HII_NAME_VALUE_NODE_FROM_LINK

◆ HII_NAME_VALUE_NODE_SIGNATURE

◆ HII_QUESTION_DEFAULT_FROM_LINK

◆ HII_QUESTION_DEFAULT_SIGNATURE

◆ HII_QUESTION_OPTION_FROM_LINK

◆ HII_QUESTION_OPTION_SIGNATURE

◆ HII_STATEMENT_FROM_LINK

◆ HII_STATEMENT_SIGNATURE

◆ HII_STORAGE_FROM_LINK

◆ HII_STORAGE_SIGNATURE

◆ STANDARD_MAP_FORM_TYPE

Typedef Documentation

◆ HII_DEPENDENCY_EXPRESSION

◆ HII_STATEMENT

Enumeration Type Documentation

◆ EXPRESS_LEVEL

◆ EXPRESS_RESULT

◆ GET_SET_QUESTION_VALUE_WITH

Function Documentation

◆ CreateFormSetFromHiiHandle()

◆ DestroyFormSet()

◆ EvaluateExpressionList()

◆ EvaluateHiiExpression()

◆ GetHiiExpressionDependency()

◆ GetQuestionDefault()

◆ GetQuestionValue()

◆ InitializeFormSet()

◆ RetrieveQuestion()

◆ SetQuestionValue()

◆ SubmitForm()