IBTIMAGEARCHIVEINITIATOR_STARTARCHIVE()
Brew Release
Brew MP 1.0.2
See Also
Description
Requests archive responder to begin archiving images from given folder.
Params
_me
[in]:
the object
pszImageFolder
[in]:
full path of image folder
piFS
[in]:
file system object on which to operate
nProgressFreq
[in]:
minimum number of bytes transferred between
progress reports
bDeleteAllowed
[in]:
TRUE allows archive responder to delete files from
source image folder after archiving them
Return
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.
Interface
Prototype
AEEResult IBTImageArchiveInitiator_StartArchive( IBTImageArchiveInitiator* _me, const char* pszImageFolder, IFileSystem2* piFS, int nProgressFreq, boolean bDeleteAllowed);
Side Effect
- None
Comments
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 archived
COMMENTS (0)
See Below