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

Developer

API Reference

IBTIMAGEPUSHINITIATOR_PUTIMAGE()

Brew Release
Brew MP 1.0.2
See Also
Description
Pushes the given image and its thumbnail version, if any, to the configured Image Push Responder. The thumbnail version, if provided, would only be sent if requested by responder. If thumbnail is requested by responder but not provided, depending on implementation, initiator object maybe able to generate it.
Params
_me
[in]:
the object
piImagePort
[in]:
source for the image
pszImageDesc
[in]:
descriptor conforming to image-descriptor DTD
pwImageName
[in]:
the image name in Unicode
piThumbnailPort
[in]:
source for image's thumbnail version, if any
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
[]:
Object not configured.
AEE_EITEMBUSY
[]:
In the middle of another operation.
Prototype
  •    AEEResult IBTImagePushInitiator_PutImage(
                    IBTImagePushInitiator* _me,
                    IPort1*                piImagePort,
                    const char*            pszImageDesc,
                    const _wchar_t*        pwImageName,
                    IPort1*                piThumbnailPort);
    
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 handle : handle assigned to the image by responder