Use doxygen comment style for document entity such as struct, enum, variable that...

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

diff --git a/MdePkg/Include/Library/PeCoffLib.h b/MdePkg/Include/Library/PeCoffLib.h
index a32b61f1889bf8e2f56e547218f09057010994b2..2b0050474be3e68cd24f3370e8eb619cc73fa0b9 100644 (file)
--- a/MdePkg/Include/Library/PeCoffLib.h
+++ b/MdePkg/Include/Library/PeCoffLib.h
@@ -10,13 +10,12 @@
   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
-  Module Name:  PeCoffLib.h\r
-\r
 **/\r
 \r
 #ifndef __BASE_PE_COFF_LIB_H__\r
 #define __BASE_PE_COFF_LIB_H__\r
 \r
+#include <IndustryStandard/PeImage.h>\r
 //\r
 // Return status codes from the PE/COFF Loader services\r
 // BUGBUG: Find where used and see if can be replaced by RETURN_STATUS codes\r
@@ -203,5 +202,22 @@ PeCoffLoaderRelocateImageForRuntime (
   )\r
 ;\r
 \r
+/**\r
+  Unloads a loaded PE/COFF image from memory and releases its taken resource.\r
+   \r
+  For NT32 emulator, the PE/COFF image loaded by system needs to release.\r
+  For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, \r
+  this function can simply return RETURN_SUCCESS.\r
 \r
+  @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
+                                    image to be unloaded.\r
+\r
+  @retval RETURN_SUCCESS            The PE/COFF image was unloaded successfully.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PeCoffLoaderUnloadImage (\r
+  IN PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
+  )\r
+;\r
 #endif\r