This interface provides a means of decoding a set of sections into a linked list of\r
leaf sections. This provides for an extensible and flexible file format.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation\r
- All rights reserved. This program and the accompanying\r
- materials are licensed and made available under the terms and\r
- conditions of the BSD License which accompanies this\r
- distribution. 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
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 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
+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
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@par Revision Reference:\r
This protocol is defined in Firmware Volume Specification.\r
- Version 0.9\r
+ Version 0.9.\r
\r
**/\r
\r
Creates and returns a new section stream handle to represent the new section stream.\r
\r
@param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r
- @param SectionStreamLength Size in bytes of the section stream.\r
- @param SectionStream Buffer containing the new section stream.\r
+ @param SectionStreamLength The size in bytes of the section stream.\r
+ @param SectionStream A buffer containing the new section stream.\r
@param SectionStreamHandle A pointer to a caller-allocated UINTN that,\r
on output, contains the new section stream handle.\r
\r
- @retval EFI_SUCCESS The SectionStream was successfully processed and\r
+ @retval EFI_SUCCESS The SectionStream was successfully processed, and\r
the section stream handle was returned.\r
@retval EFI_OUT_OF_RESOURCES The system has insufficient resources to\r
process the request.\r
\r
@param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r
@param SectionStreamHandle Indicates from which section stream to read.\r
- @param SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL, the contents of the \r
- entire section stream are returned in Buffer. If SectionType is not NULL, \r
- only the requested section is returned. EFI_SECTION_ALL matches all section \r
- types and can be used as a wild card to extract all sections in order.\r
- @param SectionDefinitionGuid Pointer to an EFI_GUID. If SectionType ==\r
- EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID\r
- to search for. If SectionType !=EFI_SECTION_GUID_DEFINED, then\r
+ @param SectionType The pointer to an EFI_SECTION_TYPE. If SectionType == NULL, \r
+ the contents of the entire section stream are returned \r
+ in Buffer. If SectionType is not NULL, only the \r
+ requested section is returned. EFI_SECTION_ALL \r
+ matches all section types and can be used as a \r
+ wild card to extract all sections in order.\r
+ @param SectionDefinitionGuid The pointer to an EFI_GUID. If SectionType ==\r
+ EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid \r
+ indicates what section GUID to search for. If \r
+ SectionType !=EFI_SECTION_GUID_DEFINED, then\r
SectionDefinitionGuid is unused and is ignored.\r
@param SectionInstance Indicates which instance of the requested section\r
type to return when SectionType is not NULL.\r
contains the new section stream handle.\r
@param Buffer Pointer to a pointer to a buffer in which the section\r
contents are returned.\r
- @param BufferSize Pointer to a caller-allocated UINTN.\r
- @param AuthenticationStatus Pointer to a caller-allocated UINT32 in\r
- which any meta-data from encapsulation GUID-defined sections is returned.\r
+ @param BufferSize A pointer to a caller-allocated UINTN.\r
+ @param AuthenticationStatus A pointer to a caller-allocated UINT32 in\r
+ which any meta-data from encapsulation GUID-defined \r
+ sections is returned.\r
\r
@retval EFI_SUCCESS The SectionStream was successfully processed and\r
the section contents were returned in Buffer.\r
- @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in\r
- the section stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,\r
- but there was no corresponding GUIDed Section Extraction Protocol in\r
- the handle database.\r
+ @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered inthe section\r
+ stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED \r
+ bit set, but there was no corresponding GUIDed \r
+ Section Extraction Protocol in the handle database.\r
@retval EFI_NOT_FOUND An error was encountered when parsing the SectionStream,\r
- which indicates that the SectionStream is not correctly formatted.\r
- Or The requested section does not exist.\r
+ which indicates that the SectionStream is not \r
+ correctly formatted. Or, the requested section does not exist.\r
@retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process\r
the request.\r
@retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The size of the input buffer is insufficient to contain the requested\r
- section. The input buffer is filled and section contents are truncated.\r
+ @retval EFI_WARN_BUFFER_TOO_SMALL The size of the input buffer is insufficient \r
+ to contain the requested section. The input \r
+ buffer is filled and section contents are truncated.\r
\r
**/\r
typedef\r
projects / mirror_edk2.git / blobdiff