Sync with PE/COFF Extra Action library class comments and add ASSERT() conditions if ImageContext is NULL.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8274 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
mdkinney
2009-05-09 00:51:14 +00:00
parent 51f1a2b5b8
commit 6cb6f078ae
2 changed files with 32 additions and 32 deletions

View File

@@ -68,13 +68,12 @@ DxeUnixPeCoffLibExtraActionConstructor (
} }
/** /**
Applies additional actions to relocate fixups to a PE/COFF image. Performs additional actions after a PE/COFF image has been loaded and relocated.
Generally this function is called after sucessfully Applying relocation fixups If ImageContext is NULL, then ASSERT().
to a PE/COFF image for some specicial purpose.
@param ImageContext Pointer to the image context structure that describes the
@param ImageContext Pointer to the image context structure that describes the PE/COFF PE/COFF image that has already been loaded and relocated.
image that is being relocated.
**/ **/
VOID VOID
@@ -86,6 +85,8 @@ PeCoffLoaderRelocateImageExtraAction (
VOID * Handle; VOID * Handle;
VOID * Entry; VOID * Entry;
ASSERT (ImageContext != NULL);
Handle = NULL; Handle = NULL;
Entry = NULL; Entry = NULL;
@@ -112,15 +113,13 @@ PeCoffLoaderRelocateImageExtraAction (
} }
/** /**
Unloads a loaded PE/COFF image from memory and releases its taken resource. Performs additional actions just before a PE/COFF image is unloaded. Any resources
that were allocated by PeCoffLoaderRelocateImageExtraAction() must be freed.
Releases any environment specific resources that were allocated when the image
specified by ImageContext was loaded using PeCoffLoaderLoadImage(). If ImageContext is NULL, then ASSERT().
If ImageContext is NULL, then ASSERT(). @param ImageContext Pointer to the image context structure that describes the
PE/COFF image that is being unloaded.
@param ImageContext Pointer to the image context structure that describes the PE/COFF
image to be unloaded.
**/ **/
VOID VOID
@@ -129,4 +128,5 @@ PeCoffLoaderUnloadImageExtraAction (
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
) )
{ {
ASSERT (ImageContext != NULL);
} }

View File

@@ -70,13 +70,12 @@ UnixPeCoffGetUnixThunkStucture (
} }
/** /**
Applies additional actions to relocate fixups to a PE/COFF image. Performs additional actions after a PE/COFF image has been loaded and relocated.
Generally this function is called after sucessfully Applying relocation fixups If ImageContext is NULL, then ASSERT().
to a PE/COFF image for some specicial purpose.
@param ImageContext Pointer to the image context structure that describes the
@param ImageContext Pointer to the image context structure that describes the PE/COFF PE/COFF image that has already been loaded and relocated.
image that is being relocated.
**/ **/
VOID VOID
@@ -88,6 +87,8 @@ PeCoffLoaderRelocateImageExtraAction (
VOID * Handle; VOID * Handle;
VOID * Entry; VOID * Entry;
ASSERT (ImageContext != NULL);
Handle = NULL; Handle = NULL;
Entry = NULL; Entry = NULL;
@@ -117,15 +118,13 @@ PeCoffLoaderRelocateImageExtraAction (
} }
/** /**
Unloads a loaded PE/COFF image from memory and releases its taken resource. Performs additional actions just before a PE/COFF image is unloaded. Any resources
that were allocated by PeCoffLoaderRelocateImageExtraAction() must be freed.
Releases any environment specific resources that were allocated when the image
specified by ImageContext was loaded using PeCoffLoaderLoadImage(). If ImageContext is NULL, then ASSERT().
If ImageContext is NULL, then ASSERT(). @param ImageContext Pointer to the image context structure that describes the
PE/COFF image that is being unloaded.
@param ImageContext Pointer to the image context structure that describes the PE/COFF
image to be unloaded.
**/ **/
VOID VOID
@@ -134,4 +133,5 @@ PeCoffLoaderUnloadImageExtraAction (
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
) )
{ {
ASSERT (ImageContext != NULL);
} }