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

Developer

API Reference

IBTOPPSERVER_GETPUSHEDDATA()

Brew Release
Brew MP 1.0.2
See Also
None
Description
Retrieves the data received from client. This API should be called in response to AEEBTOPPSVR_EV_PUSH_RSP_COMPLETE event.
If not retrieved by application, the data is kept by implementation until the next data transfer operation.
Params
_me
[in]:
the object
nOffset
[in]:
offset into the received data buffer destArray [i/o] : destination for data received from client
destArrayLen
[in]:
number of bytes destArray can hold
destArrayLenReq
[out]:
destination for size of entire data, starting from nOffset
Return
AEE_SUCCESS
[]:
The command has been scheduled, and events PUSH_RSP_PROGRESS and/or PUSH_RSP_COMPLETE will be generated.
AEE_ENOSUCH
[]:
No data available for retrieval.
AEE_EBADPARM
[]:
invalid input parameters
AEE_EBUFFERTOOSMALL
[]:
partial data from offset 0 copied to destArray; destArrayLenReq is updated with len of entire data
Interface
Prototype
  •    AEEResult IBTOPPServer_GetPushedData (IBTOPPServer* _me,
                                             int nOffset,
                                             uint8* destArray,
                                             int destArrayLen,
                                             int* destArrayLenReq);
    
Side Effect
  • None
Comments
None