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

Developer

API Reference

IBTIMAGEARCHIVEINITIATOR_GETCURRENTFILE()

Brew Release
Brew MP 1.0.2
See Also
IBTImageArchiveInitiator_StartArchive
Description
Gets the name of the file currently being archived. This API can be called when AEEBTBIPI_EV_OP_PROGRESS event with SUCCESS is received for AEEBTBIP_FUNC_START_ARCHIVE.
Params
_me
[in]:
the object
filePath
[in]:
destination for name of file being archived 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 retrieved.
AEE_EBUFFERTOOSMALL
[]:
FilePath not large enough; no partial name copied.
AEE_EBADSTATE
[]:
No files are being archived.
Prototype
  •    AEEResult IBTImageArchiveInitiator_GetCurrentFile(
                    IBTImageArchiveInitiator* _me,
                    char*                     filePath, 
                    int                       filePathLen,
                    int*                      filePathLenReq);
    
Side Effect
  • None
Comments
None