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

Developer

API Reference

IBTIMAGEPUSHINITIATOR_PUTATTACHMENT()

Brew Release
Brew MP 1.0.2
Description
Pushes an attachment of the image with the given handle. This API should be called to send individual attachments of an image previously pushed onto responder via IBTImagePushInitiator_PutImage() during the same session.
Params
_me
[in]:
the object
pHandle
[in]:
handle assigned by responder to the image associated with given attachment
piAttachmentPort
[in]:
source for the attachment
pszAttachmentDesc
[in]:
descriptor conforming to attachment-descriptor 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 IBTImagePushInitiator_PutAttachment(
                    IBTImagePushInitiator*     _me,
                    const AEEBTBIPImageHandle* pHandle,
                    IPort1*                    piAttachmentPort,
                    const char*                pszAttachmentDesc);
    
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