Developer

API Reference

IBTBIPPullInitiator_GetImage()

Brew Release
Brew MP 1.0.2
Description
Asks responder for the image with given handle.
The param pszDescriptor, if non-empty, specifies the desired format and size of the image. If no descriptor is given, image will be of responder's preferred format and size.
When AEEBTBIPI_EV_OP_COMPLETED event is received with SUCCESS, application can extract the image from the given port.
Parameters
  • _me
    [in]:
    the object
  • pHandle
    [in]:
    handle of the image of interest
  • pszDescriptor
    [in]:
    optional descriptor conforming to image-descriptor DTD
  • piDestPort
    [in]:
    destination for the image
    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_GetImage(
                IBTBIPPullInitiator*       _me,
                const AEEBTBIPImageHandle* pHandle,
                const char*                pszDescriptor,
                IPort1*                    piDestPort);
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 nSize : image size
  • Follow