API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IBTBIPPULLINITIATOR_GETIMAGEPROPERTIES()

Brew Release
Brew MP 1.0.2
Description
Asks responder for the properties of the image with the given handle.
When AEEBTBIPI_EV_OP_COMPLETED event is received with SUCCESS, application can extract the image properties from the given port.
Params
_me
[in]:
the object
pHandle
[in]:
handle of the image of interest
piDestPort
[in]:
destination for the image properties conforming to image-properties DTD
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 IBTBIPPullInitiator_GetImageProperties(
                    IBTBIPPullInitiator*       _me,
                    const AEEBTBIPImageHandle* pHandle,
                    IPort1*                     piDestPort);
    
Side Effect
  • None
Comments
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 nSize : image properties object size