]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/DeferredImageLoad.h
Update comments by UEFI approved Errata revision 'B'.
[mirror_edk2.git] / MdePkg / Include / Protocol / DeferredImageLoad.h
index 5bd9e81429dc5d09ab8ff74582e04097109ab842..494e6b8e4e2e0bd3d4e824138f1955cd1b0a7302 100644 (file)
@@ -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\r
   there are no more, at which point UserInfo will point to NULL. \r
 \r
-  @param[in]  This             Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL.\r
-  @param[in]  ImageIndex       Zero-based index of the deferred index.\r
-  @param[out] ImageDevicePath  On return, points to a pointer to the device path of the image. The device path should \r
-                               not be freed by the caller. \r
-  @param[out] Image            On return, points to the first byte of the image or NULL if the image is not available. \r
-                               The image should not be freed by the caller unless LoadImage() has been called \r
-                               successfully.  \r
-  @param[out] ImageSize        On return, the size of the image, or 0 if the image is not available.\r
-  @param[out] BootOption       On return, points to TRUE if the image was intended as a boot option or FALSE if it \r
-                               was not intended as a boot option. \r
+  @param[in]  This               Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL.\r
+  @param[in]  ImageIndex         Zero-based index of the deferred index.\r
+  @param[out] ImageDevicePath    On return, points to a pointer to the device path of the image. \r
+                                 The device path should not be freed by the caller. \r
+  @param[out] Image              On return, points to the first byte of the image or NULL if the  \r
+                                 image is not available. The image should not be freed by the caller \r
+                                 unless LoadImage() has been called successfully.  \r
+  @param[out] ImageSize          On return, the size of the image, or 0 if the image is not available.\r
+  @param[out] BootOption         On return, points to TRUE if the image was intended as a boot option \r
+                                 or FALSE if it was not intended as a boot option. \r
  \r
-  @retval EFI_SUCCESS          Image information returned successfully.\r
-  @retval EFI_NOT_FOUND        ImageIndex does not refer to a valid image.\r
+  @retval EFI_SUCCESS            Image information returned successfully.\r
+  @retval EFI_NOT_FOUND          ImageIndex does not refer to a valid image.\r
+  @retval EFI_INVALID_PARAMETER  ImageDevicePath is NULL or Image is NULL or ImageSize is NULL or \r
+                                 BootOption is NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r