Data Structures | |
struct | EFI_HII_PACK_HEADER |
struct | EFI_HII_IFR_PACK |
struct | EFI_HII_HANDLE_PACK |
struct | EFI_HII_VARIABLE_PACK |
struct | EFI_HII_DEVICE_PATH_PACK |
struct | EFI_HII_DATA_TABLE |
struct | EFI_HII_EXPORT_TABLE |
struct | EFI_HII_UPDATE_DATA |
struct | EFI_HII_STRING_PACK |
struct | EFI_HII_FONT_PACK |
struct | FRAMEWORK_EFI_KEY_DESCRIPTOR |
struct | EFI_HII_KEYBOARD_PACK |
struct | EFI_HII_PACKAGES |
struct | _EFI_HII_VARIABLE_PACK_LIST |
struct | _EFI_HII_PROTOCOL |
Defines | |
#define | EFI_HII_PROTOCOL_GUID |
#define | EFI_HII_COMPATIBILITY_PROTOCOL_GUID |
#define | EFI_HII_FONT 1 |
#define | EFI_HII_STRING 2 |
#define | EFI_HII_IFR 3 |
#define | EFI_HII_KEYBOARD 4 |
#define | EFI_HII_HANDLES 5 |
#define | EFI_HII_VARIABLE 6 |
#define | EFI_HII_DEVICE_PATH 7 |
#define | STRING_TOKEN(t) t |
#define | LANG_RIGHT_TO_LEFT 0x00000001 |
Typedefs | |
typedef UINT32 | RELOFST |
typedef struct _EFI_HII_PROTOCOL | EFI_HII_PROTOCOL |
typedef UINT16 | FRAMEWORK_EFI_HII_HANDLE |
typedef UINT16 | EFI_FORM_LABEL |
typedef struct _EFI_HII_VARIABLE_PACK_LIST | EFI_HII_VARIABLE_PACK_LIST |
typedef EFI_STATUS(EFIAPI * | EFI_HII_NEW_PACK )(IN EFI_HII_PROTOCOL *This, IN EFI_HII_PACKAGES *Packages, OUT FRAMEWORK_EFI_HII_HANDLE *Handle) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_REMOVE_PACK )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_FIND_HANDLES )(IN EFI_HII_PROTOCOL *This, IN OUT UINT16 *HandleBufferLength, OUT FRAMEWORK_EFI_HII_HANDLE *Handle) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_EXPORT )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN OUT UINTN *BufferSize, OUT VOID *Buffer) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_RESET_STRINGS )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_TEST_STRING )(IN EFI_HII_PROTOCOL *This, IN CHAR16 *StringToTest, IN OUT UINT32 *FirstMissing, OUT UINT32 *GlyphBufferSize) |
typedef EFI_STATUS(EFIAPI * | FRAMEWORK_EFI_HII_GET_GLYPH )(IN EFI_HII_PROTOCOL *This, IN CHAR16 *Source, IN OUT UINT16 *Index, OUT UINT8 **GlyphBuffer, OUT UINT16 *BitWidth, IN OUT UINT32 *InternalStatus) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_GLYPH_TO_BLT )(IN EFI_HII_PROTOCOL *This, IN UINT8 *GlyphBuffer, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background, IN UINTN Count, IN UINTN Width, IN UINTN Height, IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer) |
typedef EFI_STATUS(EFIAPI * | FRAMEWORK_EFI_HII_NEW_STRING )(IN EFI_HII_PROTOCOL *This, IN CHAR16 *Language, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN OUT STRING_REF *Reference, IN CHAR16 *NewString) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_GET_PRI_LANGUAGES )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, OUT EFI_STRING *LanguageString) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_GET_SEC_LANGUAGES )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN CHAR16 *PrimaryLanguage, OUT EFI_STRING *LanguageString) |
typedef EFI_STATUS(EFIAPI * | FRAMEWORK_EFI_HII_GET_STRING )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN STRING_REF Token, IN BOOLEAN Raw, IN CHAR16 *LanguageString, IN OUT UINTN *BufferLength, OUT EFI_STRING StringBuffer) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_GET_LINE )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN STRING_REF Token, IN OUT UINT16 *Index, IN UINT16 LineWidth, IN CHAR16 *LanguageString, IN OUT UINT16 *BufferLength, OUT EFI_STRING StringBuffer) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_GET_FORMS )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN EFI_FORM_ID FormId, IN OUT UINTN *BufferLength, OUT UINT8 *Buffer) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_GET_DEFAULT_IMAGE )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN UINTN DefaultMask, OUT EFI_HII_VARIABLE_PACK_LIST **VariablePackList) |
typedef EFI_STATUS(EFIAPI * | EFI_HII_UPDATE_FORM )(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN EFI_FORM_LABEL Label, IN BOOLEAN AddData, IN EFI_HII_UPDATE_DATA *Data) |
typedef EFI_STATUS(EFIAPI * | FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT )(IN EFI_HII_PROTOCOL *This, OUT UINT16 *DescriptorCount, OUT FRAMEWORK_EFI_KEY_DESCRIPTOR *Descriptor) |
Variables | |
EFI_GUID | gEfiHiiProtocolGuid |
EFI_GUID | gEfiHiiCompatibilityProtocolGuid |
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define EFI_HII_COMPATIBILITY_PROTOCOL_GUID |
Value:
{ \ 0x5542cce1, 0xdf5c, 0x4d1b, { 0xab, 0xca, 0x36, 0x4f, 0x77, 0xd3, 0x99, 0xfb } \ }
#define EFI_HII_DEVICE_PATH 7 |
#define EFI_HII_FONT 1 |
HII package type values
#define EFI_HII_HANDLES 5 |
#define EFI_HII_IFR 3 |
#define EFI_HII_KEYBOARD 4 |
#define EFI_HII_PROTOCOL_GUID |
Value:
{ \ 0xd7ad636e, 0xb997, 0x459b, {0xbf, 0x3f, 0x88, 0x46, 0x89, 0x79, 0x80, 0xe1} \ }
Note that EFI_HII_PROTOCOL_GUID is different from that defined in the Framework HII 0.92 specification because the specification changed part of HII interfaces but did not update the protocol GUID.
#define EFI_HII_STRING 2 |
#define EFI_HII_VARIABLE 6 |
#define LANG_RIGHT_TO_LEFT 0x00000001 |
#define STRING_TOKEN | ( | t | ) | t |
typedef UINT16 EFI_FORM_LABEL |
typedef EFI_STATUS(EFIAPI * EFI_HII_EXPORT)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN OUT UINTN *BufferSize, OUT VOID *Buffer) |
Exports the contents of the database into a buffer.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | A FRAMEWORK_EFI_HII_HANDLE that corresponds to the desired handle to export. If the value is 0, the entire database will be exported. The data is exported in a format described by the structure definition of EFI_HII_EXPORT_TABLE. | |
BufferSize | On input, a pointer to the length of the buffer. On output, the length of the buffer that is required for the export data. | |
Buffer | A pointer to a buffer that will contain the results of the export function. |
EFI_SUCCESS | The buffer was successfully filled with BufferSize amount of data. | |
EFI_BUFFER_TOO_SMALL | The value in BufferSize was too small to contain the export data. |
typedef EFI_STATUS(EFIAPI * EFI_HII_FIND_HANDLES)(IN EFI_HII_PROTOCOL *This, IN OUT UINT16 *HandleBufferLength, OUT FRAMEWORK_EFI_HII_HANDLE *Handle) |
Determines the handles that are currently active in the database.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
HandleBufferLength | On input, a pointer to the length of the handle buffer. On output, the length of the handle buffer that is required for the handles found. | |
Handle | An array of FRAMEWORK_EFI_HII_HANDLE instances returned. |
EFI_SUCCESS | Handle was updated successfully. | |
EFI_BUFFER_TOO_SMALL | The HandleBufferLength parameter indicates that Handle is too small to support the number of handles. |
typedef EFI_STATUS(EFIAPI * EFI_HII_GET_DEFAULT_IMAGE)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN UINTN DefaultMask, OUT EFI_HII_VARIABLE_PACK_LIST **VariablePackList) |
Extracts the defaults that are associated with a given handle in the HII database.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | The HII handle from which will have default data retrieved. | |
DefaultMask | The mask used to specify some type of default override when extracting the default image data. | |
VariablePackList | An indirect pointer to the first entry of a link list with type EFI_HII_VARIABLE_PACK_LIST. |
EFI_SUCCESS | The VariablePackList was populated with the appropriate default setting data. | |
EFI_NOT_FOUND | The IFR does not have any explicit or default map(s). | |
EFI_INVALID_PARAMETER | The HII database entry associated with Handle contains invalid data. |
typedef EFI_STATUS(EFIAPI * EFI_HII_GET_FORMS)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN EFI_FORM_ID FormId, IN OUT UINTN *BufferLength, OUT UINT8 *Buffer) |
Allows a program to extract a form or form package that has previously been registered with the HII database.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | Handle on which the form resides. | |
FormId | The ID of the form to return. If the ID is zero, the entire form package is returned. | |
BufferLength | On input, the length of the Buffer. On output, the length of the returned buffer, | |
Buffer | The buffer designed to receive the form(s). |
EFI_SUCCESS | Buffer filled with the requested forms. BufferLength was updated. | |
EFI_INVALID_PARAMETER | The handle is unknown. | |
EFI_NOT_FOUND | A form on the requested handle cannot be found with the requested FormId. | |
EFI_BUFFER_TOO_SMALL | The buffer provided was not large enough to allow the form to be stored. |
typedef EFI_STATUS(EFIAPI * EFI_HII_GET_LINE)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN STRING_REF Token, IN OUT UINT16 *Index, IN UINT16 LineWidth, IN CHAR16 *LanguageString, IN OUT UINT16 *BufferLength, OUT EFI_STRING StringBuffer) |
Allows a program to extract a part of a string of not more than a given width.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | The handle on which the string resides. | |
Token | The string token assigned to the string. | |
Index | On input, the offset into the string where the line is to start. On output, the index is updated to point beyond the last character returned in the call. | |
LineWidth | The maximum width of the line in units of narrow glyphs. | |
LanguageString | The pointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating the language to print. | |
BufferLength | The pointer to the length of the StringBuffer. | |
StringBuffer | The buffer designed to receive the characters in the string. |
EFI_SUCCESS | StringBuffer filled with characters that will fit on the line. | |
EFI_NOT_FOUND | The font glyph for at least one of the characters in the string is not in the font database. | |
EFI_BUFFER_TOO_SMALL | The buffer provided was not large enough to allow the entire string to be stored. |
typedef EFI_STATUS(EFIAPI * EFI_HII_GET_PRI_LANGUAGES)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, OUT EFI_STRING *LanguageString) |
Allows a program to determine the primary languages that are supported on a given handle.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | The handle on which the strings reside. | |
LanguageString | A string allocated by GetPrimaryLanguages() that contains a list of all primary languages registered on the handle. |
EFI_SUCCESS | LanguageString was correctly returned. | |
EFI_INVALID_PARAMETER | The Handle was unknown. |
typedef EFI_STATUS(EFIAPI * EFI_HII_GET_SEC_LANGUAGES)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN CHAR16 *PrimaryLanguage, OUT EFI_STRING *LanguageString) |
Allows a program to determine which secondary languages are supported on a given handle for a given primary language.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | The handle on which the strings reside. | |
PrimaryLanguage | Pointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating the primary language. | |
LanguageString | A string allocated by GetSecondaryLanguages() containing a list of all secondary languages registered on the handle. |
EFI_SUCCESS | LanguageString was correctly returned. | |
EFI_INVALID_PARAMETER | The Handle was unknown. |
typedef EFI_STATUS(EFIAPI * EFI_HII_GLYPH_TO_BLT)(IN EFI_HII_PROTOCOL *This, IN UINT8 *GlyphBuffer, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background, IN UINTN Count, IN UINTN Width, IN UINTN Height, IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer) |
Translates a glyph into the format required for input to the Universal Graphics Adapter (UGA) Block Transfer (BLT) routines.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
GlyphBuffer | A pointer to the buffer that contains glyph data. | |
Foreground | The foreground setting requested to be used for the generated BltBuffer data. | |
Background | The background setting requested to be used for the generated BltBuffer data. | |
Count | The entry in the BltBuffer upon which to act. | |
Width | The width in bits of the glyph being converted. | |
Height | The height in bits of the glyph being converted | |
BltBuffer | A pointer to the buffer that contains the data that is ready to be used by the UGA BLT routines. |
EFI_SUCCESS | Successfully translated a glyph into the required format for input to UGA BLT routines. | |
EFI_NOT_FOUND | A glyph for a character was not found. |
typedef EFI_STATUS(EFIAPI * EFI_HII_NEW_PACK)(IN EFI_HII_PROTOCOL *This, IN EFI_HII_PACKAGES *Packages, OUT FRAMEWORK_EFI_HII_HANDLE *Handle) |
Registers the various packs that are passed in via the Packages parameter.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Packages | A pointer to an EFI_HII_PACKAGES package instance. | |
Handle | A pointer to the FRAMEWORK_EFI_HII_HANDLE instance. |
EFI_SUCCESS | Data was extracted from Packages, the database was updated with the data, and Handle returned successfully. | |
EFI_INVALID_PARAMETER | The content of Packages was invalid. |
typedef struct _EFI_HII_PROTOCOL EFI_HII_PROTOCOL |
typedef EFI_STATUS(EFIAPI * EFI_HII_REMOVE_PACK)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle) |
Removes a package from the HII database.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | The handle that was registered to the data that is requested for removal. |
EFI_SUCCESS | The data associated with the Handle was removed from the HII database. | |
EFI_INVALID_PARAMETER | The Handle was not valid. |
typedef EFI_STATUS(EFIAPI * EFI_HII_RESET_STRINGS)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle) |
Remove any new strings that were added after the initial string export for this handle.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | The handle on which the string resides. |
EFI_SUCCESS | Successfully removed strings from the handle. | |
EFI_INVALID_PARAMETER | The Handle was unknown. |
typedef EFI_STATUS(EFIAPI * EFI_HII_TEST_STRING)(IN EFI_HII_PROTOCOL *This, IN CHAR16 *StringToTest, IN OUT UINT32 *FirstMissing, OUT UINT32 *GlyphBufferSize) |
Tests if all of the characters in a string have corresponding font characters.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
StringToTest | A pointer to a Unicode string. | |
FirstMissing | A pointer to an index into the string. On input, the index of the first character in the StringToTest to examine. On exit, the index of the first character encountered for which a glyph is unavailable. If all glyphs in the string are available, the index is the index of the terminator of the string. | |
GlyphBufferSize | A pointer to a value. On output, if the function returns EFI_SUCCESS, it contains the amount of memory that is required to store the string's glyph equivalent. |
EFI_SUCCESS | All glyphs are available. Note that an empty string always returns this value. | |
EFI_NOT_FOUND | A glyph was not found for a character. |
typedef EFI_STATUS(EFIAPI * EFI_HII_UPDATE_FORM)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN EFI_FORM_LABEL Label, IN BOOLEAN AddData, IN EFI_HII_UPDATE_DATA *Data) |
Allows the caller to update a form or form package that has previously been registered with the EFI HII database.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | Handle of the package where the form to be updated resides. | |
Label | The label inside the form package where the update is to take place. | |
AddData | If TRUE, adding data at a given Label; otherwise, if FALSE, removing data at a given Label. | |
Data | The buffer containing the new tags to insert after the Label |
EFI_SUCCESS | The form was updated with the new tags. | |
EFI_INVALID_PARAMETER | The buffer for the buffer length does not contain an integral number of tags. | |
EFI_NOT_FOUND | The Handle, Label, or FormId was not found. |
typedef struct _EFI_HII_VARIABLE_PACK_LIST EFI_HII_VARIABLE_PACK_LIST |
The packed link list that contains all the discernable defaults of variables for the opcodes that are defined in this Handle's domain of data.
typedef EFI_STATUS(EFIAPI * FRAMEWORK_EFI_HII_GET_GLYPH)(IN EFI_HII_PROTOCOL *This, IN CHAR16 *Source, IN OUT UINT16 *Index, OUT UINT8 **GlyphBuffer, OUT UINT16 *BitWidth, IN OUT UINT32 *InternalStatus) |
Translates a Unicode character into the corresponding font glyph.
Note that this function prototype name is different from that in the Framework HII 0.92 specification to avoid name confict with EFI_HII_GET_GLYPH defined in the UEFI 2.1d specification.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Source | A pointer to a Unicode string. | |
Index | On input, the offset into the string from which to fetch the character. On successful completion, the index is updated to the first character past the character(s) making up the just extracted glyph. | |
GlyphBuffer | Pointer to an array where the glyphs corresponding to the characters in the source may be stored. GlyphBuffer is assumed to be wide enough to accept a wide glyph character. | |
BitWidth | If EFI_SUCCESS was returned, the UINT16 pointed to by this value is filled with the length of the glyph in pixels. It is unchanged if the call was unsuccessful. | |
InternalStatus | The cell pointed to by this parameter must be initialized to zero prior to invoking the call the first time for any string. |
EFI_SUCCESS | Found the corresponding font glyph for a Unicode character. | |
EFI_NOT_FOUND | A glyph for a character was not found. |
typedef EFI_STATUS(EFIAPI * FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT)(IN EFI_HII_PROTOCOL *This, OUT UINT16 *DescriptorCount, OUT FRAMEWORK_EFI_KEY_DESCRIPTOR *Descriptor) |
Retrieves the current keyboard layout.
Note that this function prototype name is different from that in the Framework HII 0.92 specification to avoid name confict with EFI_HII_GET_KEYBOARD_LAYOUT defined in the UEFI 2.1d specification.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
DescriptorCount | A pointer to the number of Descriptor entries being described in the keyboard layout being retrieved. | |
Descriptor | A pointer to a buffer containing an array of FRAMEWORK_EFI_KEY_DESCRIPTOR entries. Each entry will reflect the definition of a specific physical key. |
EFI_SUCCESS | The keyboard layout was retrieved successfully. |
typedef EFI_STATUS(EFIAPI * FRAMEWORK_EFI_HII_GET_STRING)(IN EFI_HII_PROTOCOL *This, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN STRING_REF Token, IN BOOLEAN Raw, IN CHAR16 *LanguageString, IN OUT UINTN *BufferLength, OUT EFI_STRING StringBuffer) |
Extracts a string from a package already registered with the EFI HII database.
Note that this function prototype name is different from that in the Framework HII 0.92 specification to avoid name confict with EFI_HII_GET_STRING defined in the UEFI 2.1d specification.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Handle | The handle on which the string resides. | |
Token | The string token assigned to the string. | |
Raw | If TRUE, the string is returned unedited in the internal storage format. If false, the string returned is edited by replacing <cr> with <space> and by removing special characters such as the <wide> prefix. | |
LanguageString | Pointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating the language to print. If the LanguageString is empty (starts with a NULL), the default system language will be used to determine the language. | |
BufferLength | Length of the StringBuffer. | |
StringBuffer | The buffer designed to receive the characters in the string. |
EFI_SUCCESS | StringBuffer is filled with a NULL-terminated string. | |
EFI_INVALID_PARAMETER | The handle or string token is unknown. | |
EFI_BUFFER_TOO_SMALL | The buffer provided was not large enough to allow the entire string to be stored. |
typedef UINT16 FRAMEWORK_EFI_HII_HANDLE |
Note: Name difference between code and the Framework HII 0.92 specificaiton. Add FRAMEWORK_ prefix to avoid a name confict with EFI_HII_HANDLE, defined in the UEFI 2.1d specification.
typedef EFI_STATUS(EFIAPI * FRAMEWORK_EFI_HII_NEW_STRING)(IN EFI_HII_PROTOCOL *This, IN CHAR16 *Language, IN FRAMEWORK_EFI_HII_HANDLE Handle, IN OUT STRING_REF *Reference, IN CHAR16 *NewString) |
Allows a new string to be added to an already existing string package.
Note that this function prototype name is different from that in the Framework HII 0.92 specification to avoid name confict with EFI_HII_NEW_STRING defined in the UEFI 2.1d specification.
This | A pointer to the EFI_HII_PROTOCOL instance. | |
Pointer | to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating the language in which the string is translated. | |
Handle | The handle of the language pack to which the string is to be added. | |
Reference | The identifier of the string to be added. If the reference value is zero, then the string will be assigned a new identifier on that handle for the language specified. Otherwise, the string will be updated with the NewString Value. | |
NewString | The string to be added. |
EFI_SUCCESS | The string was effectively registered. | |
EFI_INVALID_PARAMETER | The Handle was unknown. |
typedef UINT32 RELOFST |
EFI_GUID gEfiHiiCompatibilityProtocolGuid |
EFI_GUID gEfiHiiProtocolGuid |