Developer

API Reference

IBTImagePullInitiator_GetCurrentFile()

Brew Release
Brew MP 1.0.2
See Also
IBTImagePullInitiator_PullImages
Description
Gets the name of the file currently being pulled. This API can be called when AEEBTBIPI_EV_OP_PROGRESS event is received.
Parameters
  • _me
    [in]:
    the object
  • filePath
    [in]:
    destination for name of file being pulled filePathLen [i[ : number of chars filePath can hold
  • filePathLenReq
    [out]:
    number of chars filePath must be able to hold
    Return
  • AEE_SUCCESS
    []:
    Name of file successfully copied.
  • AEE_EBUFFERTOOSMALL
    []:
    filePath not large enough; no partial name copied.
  • AEE_EBADSTATE
    []:
    PullImages not in progress.
Prototype
   AEEResult IBTImagePullInitiator_GetCurrentFile(
                IBTImagePullInitiator* _me,
                char*                  filePath, 
                int                    filePathLen,
                int*                   filePathLenReq);
Side Effect
None
Comment
None
  • Follow