Synchronization of MDE Library Spec., Mde.dec, and corresponding head files in MdePkg...

[mirror_edk2.git] / MdePkg / Include / Library / PeCoffLib.h

diff --git a/MdePkg/Include/Library/PeCoffLib.h b/MdePkg/Include/Library/PeCoffLib.h
index 47b70fff921f80d741c958f552c33b35ee362022..8e899e616dd451423d3b6dbc1de2e3c52151b8e5 100644 (file)
--- a/MdePkg/Include/Library/PeCoffLib.h
+++ b/MdePkg/Include/Library/PeCoffLib.h
@@ -1,14 +1,14 @@
 /** @file\r
-  Memory Only PE COFF loader. \r
+  Provides services to load and relocate a PE/COFF image.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+All rights reserved. This program and the accompanying materials                          \r
+are licensed and made available under the terms and conditions of the BSD License         \r
+which accompanies this 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
+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
 **/\r
 \r
@@ -85,6 +85,7 @@ typedef struct {
   VOID                              *FixupData;\r
   ///\r
   /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header\r
+  /// If the image is a TE image, then this field is set to 0.\r
   ///\r
   UINT32                            SectionAlignment;\r
   ///\r
@@ -159,13 +160,15 @@ typedef struct {
 /**\r
   Retrieves information about a PE/COFF image.\r
 \r
-  Computes the PeCoffHeaderOffset, ImageAddress, ImageSize, DestinationAddress, CodeView,\r
-  PdbPointer, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva\r
-  fields of the ImageContext structure.  If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.\r
-  If the PE/COFF image accessed through the ImageRead service in the ImageContext structure is not\r
-  a supported PE/COFF image type, then return RETURN_UNSUPPORTED.  If any errors occur while\r
-  computing the fields of ImageContext, then the error status is returned in the ImageError field of\r
-  ImageContext. \r
+  Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, \r
+  DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and \r
+  DebugDirectoryEntryRva fields of the ImageContext structure.  \r
+  If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.  \r
+  If the PE/COFF image accessed through the ImageRead service in the ImageContext \r
+  structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.  \r
+  If any errors occur while computing the fields of ImageContext, \r
+  then the error status is returned in the ImageError field of ImageContext.  \r
+  If the image is a TE image, then SectionAlignment is set to 0.\r
 \r
   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
                                     image that needs to be examined by this function.\r