| 2c40a813 |
1 | /*++\r |
| 2 | \r |
| 3 | Copyright (c) 2007, Intel Corporation \r |
| 4 | All rights reserved. This program and the accompanying materials \r |
| 5 | are licensed and made available under the terms and conditions of the BSD License \r |
| 6 | which accompanies this distribution. The full text of the license may be found at \r |
| 7 | http://opensource.org/licenses/bsd-license.php \r |
| 8 | \r |
| 9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
| 10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
| 11 | \r |
| 12 | Module Name:\r |
| 13 | \r |
| 14 | HiiString.h\r |
| 15 | \r |
| 16 | Abstract:\r |
| 17 | \r |
| 18 | EFI_HII_STRING_PROTOCOL from UEFI 2.1 specification.\r |
| 19 | \r |
| 20 | This protocol provides interfaces to manipulate string data.\r |
| 21 | \r |
| 22 | Revision History\r |
| 23 | \r |
| 24 | --*/\r |
| 25 | \r |
| 26 | #ifndef __EFI_HII_STRING_PROTOCOL_H__\r |
| 27 | #define __EFI_HII_STRING_PROTOCOL_H__\r |
| 28 | \r |
| 29 | #include EFI_PROTOCOL_DEFINITION (HiiFont)\r |
| 30 | \r |
| 31 | //\r |
| 32 | // Global ID for the Hii String Protocol.\r |
| 33 | //\r |
| 34 | #define EFI_HII_STRING_PROTOCOL_GUID \\r |
| 35 | { \\r |
| 36 | 0xfd96974, 0x23aa, 0x4cdc, 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a \\r |
| 37 | }\r |
| 38 | \r |
| 39 | EFI_FORWARD_DECLARATION (EFI_HII_STRING_PROTOCOL);\r |
| 40 | \r |
| 41 | typedef\r |
| 42 | EFI_STATUS\r |
| 43 | (EFIAPI *EFI_HII_NEW_STRING) (\r |
| 44 | IN CONST EFI_HII_STRING_PROTOCOL *This,\r |
| 45 | IN EFI_HII_HANDLE PackageList,\r |
| 46 | OUT EFI_STRING_ID *StringId,\r |
| 47 | IN CONST CHAR8 *Language,\r |
| 48 | IN CONST CHAR16 *LanguageName, OPTIONAL \r |
| 49 | IN CONST EFI_STRING String,\r |
| 50 | IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL\r |
| 51 | )\r |
| 52 | /*++\r |
| 53 | \r |
| 54 | Routine Description:\r |
| 55 | This function adds the string String to the group of strings owned by PackageList, with the\r |
| 56 | specified font information StringFontInfo and returns a new string id. \r |
| 57 | \r |
| 58 | Arguments: \r |
| 59 | This - A pointer to the EFI_HII_STRING_PROTOCOL instance.\r |
| 60 | PackageList - Handle of the package list where this string will be added. \r |
| 61 | StringId - On return, contains the new strings id, which is unique within PackageList. \r |
| 62 | Language - Points to the language for the new string.\r |
| 63 | LanguageName - Points to the printable language name to associate with the passed in \r |
| 64 | Language field.If LanguageName is not NULL and the string package header's LanguageName \r |
| 65 | associated with a given Language is not zero, the LanguageName being passed \r |
| 66 | in will be ignored. \r |
| 67 | String - Points to the new null-terminated string. \r |
| 68 |
projects / mirror_edk2.git / blame