Developer

API Reference

IBTImagePullInitiator_DeleteImage()

Brew Release
Brew MP 1.0.2
See Also
IBTImagePullInitiator_GetImagesList AEEBTBIPImageHandle
Description
Asks responder to delete the image with given handle. It is up to the responder whether or not the image's associated thumbnail version and attachments get deleted as well.
Parameters
  • _me
    [in]:
    the object
  • pHandle
    [in]:
    handle of the image of interest
    Return
  • AEE_SUCCESS
    []:
    The command has been scheduled, and AEEBTBIPI_EV_OP_INITIATED and/or AEEBTBIPI_EV_OP_COMPLETED events will be generated at a later time.
  • AEE_EBADPARM
    []:
    Invalid input parameters
  • AEE_EBADSTATE
    []:
    No longer connected to responder.
  • AEE_EITEMBUSY
    []:
    In the middle of another operation.
Prototype
   AEEResult IBTImagePullInitiator_DeleteImage(
                IBTImagePullInitiator*     _me,
                const AEEBTBIPImageHandle* pHandle);
Side Effect
None
Comment
When event AEEBTBIPI_EV_OP_COMPLETED is received the following fields of AEEBTBIPInitiatorEventType are associated with this operation: cFunc : function associated with current op cResult : result of operation
  • Follow