The form package is a collection of forms that are intended to describe the pages that will be\r
displayed to the user.\r
\r
- @param FormSetTitle Title of formset\r
- @param Guid Guid of formset\r
- @param Class Class of formset\r
- @param SubClass Sub class of formset\r
- @param FormBuffer Pointer of the formset created\r
- @param StringBuffer Pointer of FormSetTitile string created\r
+ @param FormSetTitle Title of formset\r
+ @param Guid Guid of formset\r
+ @param Class Class of formset\r
+ @param SubClass Sub class of formset\r
+ @param FormBuffer Pointer of the formset created\r
+ @param StringBuffer Pointer of FormSetTitile string created\r
\r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
- @retval EFI_SUCCESS Formset successfully created \r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
+ @retval EFI_SUCCESS Formset successfully created \r
**/\r
EFI_STATUS\r
CreateFormSet (\r
- IN CHAR16 *FormSetTitle,\r
- IN EFI_GUID *Guid,\r
- IN UINT8 Class,\r
- IN UINT8 SubClass,\r
- IN OUT VOID **FormBuffer,\r
- IN OUT VOID **StringBuffer\r
+ IN CHAR16 *FormSetTitle,\r
+ IN EFI_GUID *Guid,\r
+ IN UINT8 Class,\r
+ IN UINT8 SubClass,\r
+ IN OUT VOID **FormBuffer,\r
+ IN OUT VOID **StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- EFI_HII_IFR_PACK IfrPack;\r
- FRAMEWORK_EFI_IFR_FORM_SET FormSet;\r
- FRAMEWORK_EFI_IFR_END_FORM_SET EndFormSet;\r
- UINT8 *Destination;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ EFI_HII_IFR_PACK IfrPack;\r
+ FRAMEWORK_EFI_IFR_FORM_SET FormSet;\r
+ FRAMEWORK_EFI_IFR_END_FORM_SET EndFormSet;\r
+ UINT8 *Destination;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// Pre-allocate a buffer sufficient for us to work from.\r
}\r
\r
/**\r
- Create a form\r
+ Create a form.\r
A form is the encapsulation of what amounts to a browser page. The header defines a FormId,\r
which is referenced by the form package, among others. It also defines a FormTitle, which is a\r
string to be used as the title for the form\r
\r
- @param FormTitle Title of the form\r
- @param FormId Id of the form\r
- @param FormBuffer Pointer of the form created\r
- @param StringBuffer Pointer of FormTitil string created\r
+ @param FormTitle Title of the form\r
+ @param FormId Id of the form\r
+ @param FormBuffer Pointer of the form created\r
+ @param StringBuffer Pointer of FormTitil string created\r
\r
- @retval EFI_SUCCESS Form successfully created\r
+ @retval EFI_SUCCESS Form successfully created\r
**/\r
EFI_STATUS\r
CreateForm (\r
- IN CHAR16 *FormTitle,\r
- IN UINT16 FormId,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
+ IN CHAR16 *FormTitle,\r
+ IN UINT16 FormId,\r
+ IN OUT VOID *FormBuffer,\r
+ IN OUT VOID *StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_FORM Form;\r
- FRAMEWORK_EFI_IFR_END_FORM EndForm;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ FRAMEWORK_EFI_IFR_FORM Form;\r
+ FRAMEWORK_EFI_IFR_END_FORM EndForm;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// Obtain current language value\r
Subtitle strings are intended to be used by authors to separate sections of questions into semantic\r
groups.\r
\r
- @param SubTitle Sub title to be created\r
- @param FormBuffer Where this subtitle to add to\r
- @param StringBuffer String buffer created for subtitle\r
+ @param SubTitle Sub title to be created\r
+ @param FormBuffer Where this subtitle to add to\r
+ @param StringBuffer String buffer created for subtitle\r
\r
@retval EFI_SUCCESS Subtitle successfully created\r
**/\r
EFI_STATUS\r
CreateSubTitle (\r
- IN CHAR16 *SubTitle,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
+ IN CHAR16 *SubTitle,\r
+ IN OUT VOID *FormBuffer,\r
+ IN OUT VOID *StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_SUBTITLE Subtitle;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ FRAMEWORK_EFI_IFR_SUBTITLE Subtitle;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// Obtain current language value\r
Unlike HTML, text is simply another tag. \r
This tag type enables IFR to be more easily localized.\r
\r
- @param String - First string of the text\r
- @param String2 - Second string of the text\r
- @param String3 - Help string of the text\r
- @param Flags - Flag of the text\r
- @param Key - Key of the text\r
- @param FormBuffer - The form where this text adds to\r
- @param StringBuffer - String buffer created for String, String2 and String3\r
+ @param String First string of the text\r
+ @param String2 Second string of the text\r
+ @param String3 Help string of the text\r
+ @param Flags Flag of the text\r
+ @param Key Key of the text\r
+ @param FormBuffer The form where this text adds to\r
+ @param StringBuffer String buffer created for String, String2 and String3\r
\r
- @retval EFI_SUCCESS - Text successfully created\r
+ @retval EFI_SUCCESS Text successfully created\r
**/\r
EFI_STATUS\r
CreateText (\r
- IN CHAR16 *String,\r
- IN CHAR16 *String2,\r
- IN CHAR16 *String3,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
+ IN CHAR16 *String,\r
+ IN CHAR16 *String2,\r
+ IN CHAR16 *String3,\r
+ IN UINT8 Flags,\r
+ IN UINT16 Key,\r
+ IN OUT VOID *FormBuffer,\r
+ IN OUT VOID *StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_TEXT Text;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ FRAMEWORK_EFI_IFR_TEXT Text;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// Obtain current language value\r
}\r
\r
/**\r
- Create a hyperlink\r
+ Create a hyperlink.\r
\r
- @param FormId Form ID of the hyperlink\r
- @param Prompt Prompt of the hyperlink\r
- @param FormBuffer The form where this hyperlink adds to\r
- @param StringBuffer String buffer created for Prompt\r
+ @param FormId Form ID of the hyperlink\r
+ @param Prompt Prompt of the hyperlink\r
+ @param FormBuffer The form where this hyperlink adds to\r
+ @param StringBuffer String buffer created for Prompt\r
\r
- @retval EFI_SUCCESS Hyperlink successfully created \r
+ @retval EFI_SUCCESS Hyperlink successfully created \r
**/\r
EFI_STATUS\r
CreateGoto (\r
- IN UINT16 FormId,\r
- IN CHAR16 *Prompt,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
+ IN UINT16 FormId,\r
+ IN CHAR16 *Prompt,\r
+ IN OUT VOID *FormBuffer,\r
+ IN OUT VOID *StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_REF Hyperlink;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ FRAMEWORK_EFI_IFR_REF Hyperlink;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// Obtain current language value\r
Create a one-of question with a set of options to choose from. The\r
OptionsList is a pointer to a null-terminated list of option descriptions.\r
\r
- @param QuestionId - Question ID of the one-of box\r
- @param DataWidth - DataWidth of the one-of box\r
- @param Prompt - Prompt of the one-of box\r
- @param Help - Help of the one-of box\r
- @param OptionsList - Each string in it is an option of the one-of box\r
- @param OptionCount - Option string count\r
- @param FormBuffer - The form where this one-of box adds to\r
- @param StringBuffer - String buffer created for Prompt, Help and Option strings\r
+ @param QuestionId Question ID of the one-of box\r
+ @param DataWidth DataWidth of the one-of box\r
+ @param Prompt Prompt of the one-of box\r
+ @param Help Help of the one-of box\r
+ @param OptionsList Each string in it is an option of the one-of box\r
+ @param OptionCount Option string count\r
+ @param FormBuffer The form where this one-of box adds to\r
+ @param StringBuffer String buffer created for Prompt, Help and Option strings\r
\r
- @retval EFI_DEVICE_ERROR - DataWidth > 2\r
- @retval EFI_SUCCESS - One-Of box successfully created.\r
+ @retval EFI_DEVICE_ERROR DataWidth > 2\r
+ @retval EFI_SUCCESS One-Of box successfully created.\r
**/\r
EFI_STATUS\r
CreateOneOf (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\r
- IN IFR_OPTION *OptionsList,\r
- IN UINTN OptionCount,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 DataWidth,\r
+ IN CHAR16 *Prompt,\r
+ IN CHAR16 *Help,\r
+ IN IFR_OPTION *OptionsList,\r
+ IN UINTN OptionCount,\r
+ IN OUT VOID *FormBuffer,\r
+ IN OUT VOID *StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- UINTN Index;\r
- FRAMEWORK_EFI_IFR_ONE_OF OneOf;\r
- FRAMEWORK_EFI_IFR_ONE_OF_OPTION OneOfOption;\r
- FRAMEWORK_EFI_IFR_END_ONE_OF EndOneOf;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ UINTN Index;\r
+ FRAMEWORK_EFI_IFR_ONE_OF OneOf;\r
+ FRAMEWORK_EFI_IFR_ONE_OF_OPTION OneOfOption;\r
+ FRAMEWORK_EFI_IFR_END_ONE_OF EndOneOf;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// We do not create op-code storage widths for one-of in excess of 16 bits for now\r
Create a one-of question with a set of options to choose from. The\r
OptionsList is a pointer to a null-terminated list of option descriptions.\r
\r
- @param QuestionId - Question ID of the ordered list\r
- @param MaxEntries - MaxEntries of the ordered list\r
- @param Prompt - Prompt of the ordered list\r
- @param Help - Help of the ordered list\r
- @param OptionsList - Each string in it is an option of the ordered list\r
- @param OptionCount - Option string count\r
- @param FormBuffer - The form where this ordered list adds to\r
- @param StringBuffer - String buffer created for Prompt, Help and Option strings\r
+ @param QuestionId Question ID of the ordered list\r
+ @param MaxEntries MaxEntries of the ordered list\r
+ @param Prompt Prompt of the ordered list\r
+ @param Help Help of the ordered list\r
+ @param OptionsList Each string in it is an option of the ordered list\r
+ @param OptionCount Option string count\r
+ @param FormBuffer The form where this ordered list adds to\r
+ @param StringBuffer String buffer created for Prompt, Help and Option strings\r
\r
- @retval EFI_SUCCESS - Ordered list successfully created.\r
+ @retval EFI_SUCCESS Ordered list successfully created.\r
**/\r
EFI_STATUS\r
CreateOrderedList (\r
- IN UINT16 QuestionId,\r
- IN UINT8 MaxEntries,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\r
- IN IFR_OPTION *OptionsList,\r
- IN UINTN OptionCount,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 MaxEntries,\r
+ IN CHAR16 *Prompt,\r
+ IN CHAR16 *Help,\r
+ IN IFR_OPTION *OptionsList,\r
+ IN UINTN OptionCount,\r
+ IN OUT VOID *FormBuffer,\r
+ IN OUT VOID *StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- UINTN Index;\r
- FRAMEWORK_EFI_IFR_ORDERED_LIST OrderedList;\r
- FRAMEWORK_EFI_IFR_ONE_OF_OPTION OrderedListOption;\r
- FRAMEWORK_EFI_IFR_END_ONE_OF EndOrderedList;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ UINTN Index;\r
+ FRAMEWORK_EFI_IFR_ORDERED_LIST OrderedList;\r
+ FRAMEWORK_EFI_IFR_ONE_OF_OPTION OrderedListOption;\r
+ FRAMEWORK_EFI_IFR_END_ONE_OF EndOrderedList;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// Obtain current language value\r
}\r
\r
/**\r
- Create a checkbox\r
+ Create a checkbox.\r
\r
- @param QuestionId Question ID of the check box\r
- @param DataWidth DataWidth of the check box\r
- @param Prompt Prompt of the check box\r
- @param Help Help of the check box \r
- @param Flags Flags of the check box\r
- @param FormBuffer The form where this check box adds to\r
- @param StringBuffer String buffer created for Prompt and Help.\r
+ @param QuestionId Question ID of the check box\r
+ @param DataWidth DataWidth of the check box\r
+ @param Prompt Prompt of the check box\r
+ @param Help Help of the check box \r
+ @param Flags Flags of the check box\r
+ @param FormBuffer The form where this check box adds to\r
+ @param StringBuffer String buffer created for Prompt and Help.\r
\r
- @retval EFI_DEVICE_ERROR DataWidth > 1\r
- @retval EFI_SUCCESS Check box successfully created\r
+ @retval EFI_DEVICE_ERROR DataWidth > 1\r
+ @retval EFI_SUCCESS Check box successfully created\r
**/\r
EFI_STATUS\r
CreateCheckBox (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\r
- IN UINT8 Flags,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 DataWidth,\r
+ IN CHAR16 *Prompt,\r
+ IN CHAR16 *Help,\r
+ IN UINT8 Flags,\r
+ IN OUT VOID *FormBuffer,\r
+ IN OUT VOID *StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_CHECKBOX CheckBox;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ FRAMEWORK_EFI_IFR_CHECKBOX CheckBox;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// We do not create op-code storage widths for checkbox in excess of 8 bits for now\r
/**\r
Create a numeric\r
\r
- @param QuestionId Question ID of the numeric\r
- @param DataWidth DataWidth of the numeric\r
- @param Prompt Prompt of the numeric\r
- @param Help Help of the numeric\r
- @param Minimum Minumun boundary of the numeric\r
- @param Maximum Maximum boundary of the numeric\r
- @param Step Step of the numeric\r
- @param Default Default value\r
- @param Flags Flags of the numeric\r
- @param Key Key of the numeric\r
- @param FormBuffer The form where this numeric adds to\r
- @param StringBuffer String buffer created for Prompt and Help.\r
-\r
- @retval EFI_DEVICE_ERROR DataWidth > 2\r
- @retval EFI_SUCCESS Numeric is successfully created \r
+ @param QuestionId Question ID of the numeric\r
+ @param DataWidth DataWidth of the numeric\r
+ @param Prompt Prompt of the numeric\r
+ @param Help Help of the numeric\r
+ @param Minimum Minumun boundary of the numeric\r
+ @param Maximum Maximum boundary of the numeric\r
+ @param Step Step of the numeric\r
+ @param Default Default value\r
+ @param Flags Flags of the numeric\r
+ @param Key Key of the numeric\r
+ @param FormBuffer The form where this numeric adds to\r
+ @param StringBuffer String buffer created for Prompt and Help.\r
+\r
+ @retval EFI_DEVICE_ERROR DataWidth > 2\r
+ @retval EFI_SUCCESS Numeric is successfully created \r
**/\r
EFI_STATUS\r
CreateNumeric (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\r
- IN UINT16 Minimum,\r
- IN UINT16 Maximum,\r
- IN UINT16 Step,\r
- IN UINT16 Default,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 DataWidth,\r
+ IN CHAR16 *Prompt,\r
+ IN CHAR16 *Help,\r
+ IN UINT16 Minimum,\r
+ IN UINT16 Maximum,\r
+ IN UINT16 Step,\r
+ IN UINT16 Default,\r
+ IN UINT8 Flags,\r
+ IN UINT16 Key,\r
+ IN OUT VOID *FormBuffer,\r
+ IN OUT VOID *StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_NUMERIC Numeric;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ FRAMEWORK_EFI_IFR_NUMERIC Numeric;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// We do not create op-code storage widths for numerics in excess of 16 bits for now\r
}\r
\r
/**\r
- Create a string\r
+ Create a string.\r
\r
- @param QuestionId - Question ID of the string\r
- @param DataWidth - DataWidth of the string\r
- @param Prompt - Prompt of the string\r
- @param Help - Help of the string\r
- @param MinSize - Min size boundary of the string\r
- @param MaxSize - Max size boundary of the string\r
- @param Flags - Flags of the string\r
- @param Key - Key of the string\r
- @param FormBuffer - The form where this string adds to\r
- @param StringBuffer - String buffer created for Prompt and Help.\r
- @retval EFI_SUCCESS - String successfully created. \r
+ @param QuestionId Question ID of the string\r
+ @param DataWidth DataWidth of the string\r
+ @param Prompt Prompt of the string\r
+ @param Help Help of the string\r
+ @param MinSize Min size boundary of the string\r
+ @param MaxSize Max size boundary of the string\r
+ @param Flags Flags of the string\r
+ @param Key Key of the string\r
+ @param FormBuffer The form where this string adds to\r
+ @param StringBuffer String buffer created for Prompt and Help.\r
+ \r
+ @retval EFI_SUCCESS String successfully created. \r
**/\r
EFI_STATUS\r
CreateString (\r
- IN UINT16 QuestionId,\r
- IN UINT8 DataWidth,\r
- IN CHAR16 *Prompt,\r
- IN CHAR16 *Help,\r
- IN UINT8 MinSize,\r
- IN UINT8 MaxSize,\r
- IN UINT8 Flags,\r
- IN UINT16 Key,\r
- IN OUT VOID *FormBuffer,\r
- IN OUT VOID *StringBuffer\r
+ IN UINT16 QuestionId,\r
+ IN UINT8 DataWidth,\r
+ IN CHAR16 *Prompt,\r
+ IN CHAR16 *Help,\r
+ IN UINT8 MinSize,\r
+ IN UINT8 MaxSize,\r
+ IN UINT8 Flags,\r
+ IN UINT16 Key,\r
+ IN OUT VOID *FormBuffer,\r
+ IN OUT VOID *StringBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- FRAMEWORK_EFI_IFR_STRING String;\r
- CHAR16 CurrentLanguage[4];\r
- STRING_REF StringToken;\r
+ EFI_STATUS Status;\r
+ FRAMEWORK_EFI_IFR_STRING String;\r
+ CHAR16 CurrentLanguage[4];\r
+ STRING_REF StringToken;\r
\r
//\r
// Obtain current language value\r
projects / mirror_edk2.git / blobdiff