used by resources that want to publish IFR/Font/String data and have it\r
collected by the Configuration engine.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php. \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+http://opensource.org/licenses/bsd-license.php.\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@par Revision Reference:\r
Removes a package from the HII database.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Handle The handle that was registered to the data that \r
+ @param Handle The handle that was registered to the data that\r
is requested for removal.\r
\r
@retval EFI_SUCCESS The data associated with the Handle was removed\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param StringToTest A pointer to a Unicode string.\r
@param FirstMissing A pointer to an index into the string. On input,\r
- the index of the first character in the StringToTest \r
- to examine. On exit, the index of the first character \r
+ the index of the first character in the StringToTest\r
+ to examine. On exit, the index of the first character\r
encountered for which a glyph is unavailable.\r
- If all glyphs in the string are available, the \r
+ If all glyphs in the string are available, the\r
index is the index of the terminator of the string.\r
@param GlyphBufferSize A pointer to a value. On output, if the function\r
- returns EFI_SUCCESS, it contains the amount of \r
- memory that is required to store the string's \r
+ returns EFI_SUCCESS, it contains the amount of\r
+ memory that is required to store the string's\r
glyph equivalent.\r
\r
@retval EFI_SUCCESS All glyphs are available. Note that an empty string\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Source A pointer to a Unicode string.\r
- @param Index On input, the offset into the string from which to \r
- fetch the character. On successful completion, the \r
- index is updated to the first character past the \r
+ @param Index On input, the offset into the string from which to\r
+ fetch the character. On successful completion, the\r
+ index is updated to the first character past the\r
character(s) making up the just extracted glyph.\r
@param GlyphBuffer Pointer to an array where the glyphs corresponding\r
- to the characters in the source may be stored. \r
- GlyphBuffer is assumed to be wide enough to accept \r
+ to the characters in the source may be stored.\r
+ GlyphBuffer is assumed to be wide enough to accept\r
a wide glyph character.\r
@param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by\r
this value is filled with the length of the glyph in\r
pixels. It is unchanged if the call was unsuccessful.\r
@param InternalStatus The cell pointed to by this parameter must be\r
- initialized to zero prior to invoking the call the \r
+ initialized to zero prior to invoking the call the\r
first time for any string.\r
\r
- @retval EFI_SUCCESS Found the corresponding font glyph for a Unicode \r
- character. \r
+ @retval EFI_SUCCESS Found the corresponding font glyph for a Unicode\r
+ character.\r
@retval EFI_NOT_FOUND A glyph for a character was not found.\r
\r
**/\r
@param BltBuffer A pointer to the buffer that contains the data that is\r
ready to be used by the UGA BLT routines.\r
\r
- @retval EFI_SUCCESS Successfully translated a glyph into the required \r
+ @retval EFI_SUCCESS Successfully translated a glyph into the required\r
format for input to UGA BLT routines.\r
@retval EFI_NOT_FOUND A glyph for a character was not found.\r
@note Inconsistent with specification here:\r
to avoid name confict with EFI_HII_NEW_STRING defined in the UEFI 2.1d specification.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
- @param Pointer to a NULL-terminated string containing a single \r
- ISO 639-2 language identifier, indicating the language \r
- in which the string is translated. \r
- @param Handle The handle of the language pack to which the string \r
+ @param Pointer to a NULL-terminated string containing a single\r
+ ISO 639-2 language identifier, indicating the language\r
+ in which the string is translated.\r
+ @param Handle The handle of the language pack to which the string\r
is to be added.\r
- @param Reference The identifier of the string to be added. If the \r
- reference value is zero, then the string will be \r
+ @param Reference The identifier of the string to be added. If the\r
+ reference value is zero, then the string will be\r
assigned a new identifier on that handle for\r
- the language specified. Otherwise, the string will \r
+ the language specified. Otherwise, the string will\r
be updated with the NewString Value.\r
@param NewString The string to be added.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The handle on which the strings reside.\r
@param LanguageString A string allocated by GetPrimaryLanguages() that\r
- contains a list of all primary languages registered \r
+ contains a list of all primary languages registered\r
on the handle.\r
\r
@retval EFI_SUCCESS LanguageString was correctly returned.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The handle on which the strings reside.\r
- @param PrimaryLanguage Pointer to a NULL-terminated string containing a \r
- single ISO 639-2 language identifier, indicating \r
+ @param PrimaryLanguage Pointer to a NULL-terminated string containing a\r
+ single ISO 639-2 language identifier, indicating\r
the primary language.\r
@param LanguageString A string allocated by GetSecondaryLanguages()\r
- containing a list of all secondary languages \r
+ containing a list of all secondary languages\r
registered on the handle.\r
\r
@retval EFI_SUCCESS LanguageString was correctly returned.\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The handle on which the string resides.\r
@param Token The string token assigned to the string.\r
- @param Raw If TRUE, the string is returned unedited in the \r
- internal storage format. If false, the string \r
- returned is edited by replacing <cr> with <space> \r
+ @param Raw If TRUE, the string is returned unedited in the\r
+ internal storage format. If false, the string\r
+ returned is edited by replacing <cr> with <space>\r
and by removing special characters such as the\r
<wide> prefix.\r
@param LanguageString Pointer to a NULL-terminated string containing a\r
- single ISO 639-2 language identifier, indicating \r
- the language to print. If the LanguageString is \r
+ single ISO 639-2 language identifier, indicating\r
+ the language to print. If the LanguageString is\r
empty (starts with a NULL), the default system\r
language will be used to determine the language.\r
@param BufferLength Length of the StringBuffer.\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The handle on which the string resides.\r
@param Token The string token assigned to the string.\r
- @param Index On input, the offset into the string where the \r
- line is to start. On output, the index is updated \r
- to point beyond the last character returned in \r
+ @param Index On input, the offset into the string where the\r
+ line is to start. On output, the index is updated\r
+ to point beyond the last character returned in\r
the call.\r
@param LineWidth The maximum width of the line in units of narrow glyphs.\r
@param LanguageString The pointer to a NULL-terminated string containing a\r
- single ISO 639-2 language identifier, indicating \r
+ single ISO 639-2 language identifier, indicating\r
the language to print.\r
@param BufferLength The pointer to the length of the StringBuffer.\r
- @param StringBuffer The buffer designed to receive the characters in \r
+ @param StringBuffer The buffer designed to receive the characters in\r
the string.\r
\r
- @retval EFI_SUCCESS StringBuffer filled with characters that will fit \r
+ @retval EFI_SUCCESS StringBuffer filled with characters that will fit\r
on the line.\r
@retval EFI_NOT_FOUND The font glyph for at least one of the characters in\r
the string is not in the font database.\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The HII handle from which will have default data retrieved.\r
- @param DefaultMask The mask used to specify some type of default \r
+ @param DefaultMask The mask used to specify some type of default\r
override when extracting the default image data.\r
- @param VariablePackList An indirect pointer to the first entry of a link \r
+ @param VariablePackList An indirect pointer to the first entry of a link\r
list with type EFI_HII_VARIABLE_PACK_LIST.\r
\r
@retval EFI_SUCCESS The VariablePackList was populated with the appropriate\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param DescriptorCount A pointer to the number of Descriptor entries being\r
described in the keyboard layout being retrieved.\r
- @param Descriptor A pointer to a buffer containing an array of \r
- FRAMEWORK_EFI_KEY_DESCRIPTOR entries. Each entry \r
+ @param Descriptor A pointer to a buffer containing an array of\r
+ FRAMEWORK_EFI_KEY_DESCRIPTOR entries. Each entry\r
will reflect the definition of a specific physical key.\r
\r
@retval EFI_SUCCESS The keyboard layout was retrieved successfully.\r
projects / mirror_edk2.git / blobdiff