WdCopyFilesStatusCallback
Called to report file copy progress during a copy operation.Syntax
Parameters
fileProgressCount _In_Type: size_t The number of files that have progress updates since the last callback invocation.
fileUpdates _In_reads_opt_(fileProgressCount)Type: const WdCopyFileProgressInfo* A pointer to an array of WdCopyFileProgressInfo structures, each containing progress information for an individual file. May be
nullptr if fileProgressCount is 0.
copyUpdates _In_Type: const WdCopyOperationSummary* A pointer to a WdCopyOperationSummary structure containing a summary of the overall copy operation progress.
context _In_opt_
Type: void*
The user-defined context pointer that was specified in the WdCopyStatusCallbacks structure.
Return value
Type: HRESULT ReturnS_OK to continue the copy operation. Return a failure HRESULT to abort the copy.
Remarks
This callback is invoked by WdRemoteCopy to report progress on individual files during a copy operation. The frequency of invocations is controlled by therefreshRateMs member of WdCopyStatusCallbacks.
Returning a failed HRESULT from this callback will abort the copy operation and return that error from WdRemoteCopy.
The callback is invoked on the same thread as the WdRemoteCopy call. The fileUpdates array, copyUpdates structure, and their contents are only valid for the duration of the callback invocation.