Developer

API Reference

IBTImagePullInitiator_PullImages()

Brew Release
Brew MP 1.0.2
See Also
IFileSystem2 IBTImagePullInitiator_GetCurrentFile
Description
Pulls from responder up to nMaxImages images matching the filtering mask.
Application can call IBTImagePullInitiator_GetCurrentFile() when receiving AEEBTBIPI_EV_OP_PROGRESS event to find out the name of the file being pulled.
Parameters
  • _me
    [in]:
    the object
  • nMaxImages
    [in]:
    max number of images to pull
  • bLatest
    [in]:
    TRUE to indicate only latest images are requested
  • bDelete
    [in]:
    TRUE to delete images after pulling them from responder
  • pszFilterXML
    [in]:
    filtering mask conforming to image-handles-descriptor DTD
  • pszDestFolder
    [in]:
    destination folder for the images pulled from responder
  • piFS
    [in]:
    file system object on which to operate
  • nProgressFreq
    [in]:
    minimum number of bytes transferred between progress reports
    Return
  • AEE_SUCCESS
    []:
    The command has been scheduled, and AEEBTBIPI_EV_OP_INITIATED, AEEBTBIPI_EV_OP_PROGRESS, 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 IBTImagePullInitiator_PullImages(
                IBTImagePullInitiator* _me,
                int                    nMaxImages,
                boolean                bLatest, 
                boolean                bDelete, 
                const char*            pszFilterXML,
                const char*            pszDestFolder
                IFileSystem2*          piFS,
                int                    nProgressFreq);
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 nCount : number of images pulled
  • Follow