Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Called to report file copy progress during a copy operation.
Syntax
typedef HRESULT (*WdCopyFilesStatusCallback)(
_In_ size_t fileProgressCount,
_In_reads_opt_(fileProgressCount) const WdCopyFileProgressInfo* fileUpdates,
_In_ const WdCopyOperationSummary* copyUpdates,
_In_opt_ void* context
);
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
A failed callback HRESULT is logged but does not abort the copy or change the result returned by WdRemoteCopy.
Remarks
This callback is invoked by WdRemoteCopy to report progress on individual files during a copy operation. The frequency of invocations is controlled by the refreshRateMs member of WdCopyStatusCallbacks.
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.
Requirements
| Requirement | Value |
|---|---|
| Header | WdRemoteIteration.h |
| Library | wdremoteapi.lib |
| Supported OS | Windows 11 and later |
| Supported architectures | x64, ARM64 |