]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Protocol/SectionExtraction.h
IntelFrameworkPkg: Clean up source files
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SectionExtraction.h
index ef1d24ae52ae2025d5da92025637510c2eeedd01..f4725cc8b3dcce80ef038992172a476c8098e04a 100644 (file)
@@ -4,13 +4,13 @@
   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
   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 - 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) 2006 - 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
 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
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
@@ -66,15 +66,15 @@ EFI_STATUS
 \r
   @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r
   @param  SectionStreamHandle   Indicates from which section stream to read.\r
 \r
   @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r
   @param  SectionStreamHandle   Indicates from which section stream to read.\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
+  @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
                                 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
+                                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
                                 SectionType !=EFI_SECTION_GUID_DEFINED, then\r
                                 SectionDefinitionGuid is unused and is ignored.\r
   @param  SectionInstance       Indicates which instance of the requested section\r
@@ -85,23 +85,23 @@ EFI_STATUS
                                 contents are returned.\r
   @param  BufferSize            A pointer to a caller-allocated UINTN.\r
   @param  AuthenticationStatus  A pointer to a caller-allocated UINT32 in\r
                                 contents are 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
+                                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 inthe section\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 inthe section\r
-                                stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED \r
-                                bit set, but there was no corresponding GUIDed \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
                                 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 \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
                                 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 \r
-                                    to contain the requested section. The input \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
                                     buffer is filled and section contents are truncated.\r
 \r
 **/\r