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.
Contains callback function pointers and settings for receiving copy status updates.
Syntax
struct WdCopyStatusCallbacks
{
WdCopyFilesStatusCallback copyFilesStatusCallback;
uint32_t refreshRateMs;
WdCopyErrorCallback copyErrorCallback;
void* context;
};
Members
copyFilesStatusCallback
Type: WdCopyFilesStatusCallback
A callback function that is invoked to report file copy progress. Set to nullptr if file progress updates are not needed.
refreshRateMs
Type: uint32_t
The minimum interval in milliseconds between callback invocations for the copyFilesStatusCallback. If not specified or set to 0, the default refresh rate is 500ms.
copyErrorCallback
Type: WdCopyErrorCallback
An optional callback function that receives diagnostic messages from the copy operation, such as errors or warnings. Set to nullptr if diagnostic messages are not needed.
context
Type: void*
An optional user-defined context pointer that is passed to both callback functions. Set to nullptr if no context is needed.
Remarks
Pass this structure to WdRemoteCopy via the statusCallbacks parameter to receive progress updates and diagnostic messages during a copy operation. The refreshRateMs member controls how frequently the copyFilesStatusCallback is invoked. If not specified or set to 0, the default refresh rate is 500ms. The context pointer is passed through to both callbacks unchanged, allowing you to associate the callbacks with application-specific state.
Requirements
| Requirement | Value |
|---|---|
| Header | WdRemoteIteration.h |
| Library | wdremoteapi.lib |
| Supported OS | Windows 11 and later |
| Supported architectures | x64, ARM64 |