summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Protocol/DeferredImageLoad.h
diff options
context:
space:
mode:
authorgdong1 <gdong1@6f19259b-4bc3-4df7-8a09-765794883524>2010-02-27 10:57:24 +0000
committergdong1 <gdong1@6f19259b-4bc3-4df7-8a09-765794883524>2010-02-27 10:57:24 +0000
commit7fedcf9d2ac7884c3c766cade7d6f4dae70fc496 (patch)
tree8bd4af4d53f0dba212cc9bf755b4b89d9fa15f0f /MdePkg/Include/Protocol/DeferredImageLoad.h
parent771ececd1288bb2bee8ea6fee61a1a0220914be5 (diff)
downloadedk2-platforms-7fedcf9d2ac7884c3c766cade7d6f4dae70fc496.tar.xz
Update comments by UEFI approved Errata revision 'B'.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10117 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/DeferredImageLoad.h')
-rw-r--r--MdePkg/Include/Protocol/DeferredImageLoad.h26
1 files changed, 14 insertions, 12 deletions
diff --git a/MdePkg/Include/Protocol/DeferredImageLoad.h b/MdePkg/Include/Protocol/DeferredImageLoad.h
index 5bd9e81429..494e6b8e4e 100644
--- a/MdePkg/Include/Protocol/DeferredImageLoad.h
+++ b/MdePkg/Include/Protocol/DeferredImageLoad.h
@@ -41,19 +41,21 @@ typedef struct _EFI_DEFERRED_IMAGE_LOAD_PROTOCOL EFI_DEFERRED_IMAGE_LOAD_PROTOC
of the location of the executable image rather than its actual contents. record handle until
there are no more, at which point UserInfo will point to NULL.
- @param[in] This Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL.
- @param[in] ImageIndex Zero-based index of the deferred index.
- @param[out] ImageDevicePath On return, points to a pointer to the device path of the image. The device path should
- not be freed by the caller.
- @param[out] Image On return, points to the first byte of the image or NULL if the image is not available.
- The image should not be freed by the caller unless LoadImage() has been called
- successfully.
- @param[out] ImageSize On return, the size of the image, or 0 if the image is not available.
- @param[out] BootOption On return, points to TRUE if the image was intended as a boot option or FALSE if it
- was not intended as a boot option.
+ @param[in] This Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL.
+ @param[in] ImageIndex Zero-based index of the deferred index.
+ @param[out] ImageDevicePath On return, points to a pointer to the device path of the image.
+ The device path should not be freed by the caller.
+ @param[out] Image On return, points to the first byte of the image or NULL if the
+ image is not available. The image should not be freed by the caller
+ unless LoadImage() has been called successfully.
+ @param[out] ImageSize On return, the size of the image, or 0 if the image is not available.
+ @param[out] BootOption On return, points to TRUE if the image was intended as a boot option
+ or FALSE if it was not intended as a boot option.
- @retval EFI_SUCCESS Image information returned successfully.
- @retval EFI_NOT_FOUND ImageIndex does not refer to a valid image.
+ @retval EFI_SUCCESS Image information returned successfully.
+ @retval EFI_NOT_FOUND ImageIndex does not refer to a valid image.
+ @retval EFI_INVALID_PARAMETER ImageDevicePath is NULL or Image is NULL or ImageSize is NULL or
+ BootOption is NULL.
**/
typedef
EFI_STATUS