X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FHiiString.h;h=3deeac033a1bbd1976e6839c9b41602b4bf33ebb;hp=d0b7e0d2218bd368658c0e66369d9bb781963a55;hb=9df063a06aef048c042498e2f542fb693e93493a;hpb=1e966f6375d3b9fe77c6e4a6974f771f67182694 diff --git a/MdePkg/Include/Protocol/HiiString.h b/MdePkg/Include/Protocol/HiiString.h index d0b7e0d221..3deeac033a 100644 --- a/MdePkg/Include/Protocol/HiiString.h +++ b/MdePkg/Include/Protocol/HiiString.h @@ -1,14 +1,14 @@ /** @file The file provides services to manipulate string data. - Copyright (c) 2006 - 2008, 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 - which 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. +Copyright (c) 2006 - 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. **/ @@ -24,10 +24,12 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL; /** This function adds the string String to the group of strings owned by PackageList, with the - specified font information StringFontInfo and returns a new string id. + specified font information StringFontInfo, and returns a new string id. + The new string identifier is guaranteed to be unique within the package list. + That new string identifier is reserved for all languages in the package list. @param This A pointer to the EFI_HII_STRING_PROTOCOL instance. - @param PackageList Handle of the package list where this string will + @param PackageList The handle of the package list where this string will be added. @param StringId On return, contains the new strings id, which is unique within PackageList. @@ -36,7 +38,7 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL; with the passed in Language field.If LanguageName is not NULL and the string package header's LanguageName associated with a given Language is - not zero, the LanguageName being passed in will + not zero, the LanguageName being passed in will be ignored. @param String Points to the new null-terminated string. @param StringFontInfo Points to the new string's font information or @@ -47,7 +49,7 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL; @retval EFI_NOT_FOUND The specified PackageList could not be found in database. @retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources. - @retval EFI_INVALID_PARAMETER String is NULL or StringId is NULL or Language is NULL. + @retval EFI_INVALID_PARAMETER String is NULL, or StringId is NULL, or Language is NULL. @retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in current database.