FileSyncProvider.CopyingFile Event

  • Article

Occurs periodically to show progress while a file is being copied.

Namespace: Microsoft.Synchronization.Files
Assembly: Microsoft.Synchronization.Files (in microsoft.synchronization.files.dll)

Syntax

'Declaration
Public Event CopyingFile As EventHandler(Of CopyingFileEventArgs)
'Usage
Dim instance As FileSyncProvider
Dim handler As EventHandler(Of CopyingFileEventArgs)

AddHandler instance.CopyingFile, handler

public event EventHandler<CopyingFileEventArgs> CopyingFile

public:
event EventHandler<CopyingFileEventArgs^>^ CopyingFile {
    void add (EventHandler<CopyingFileEventArgs^>^ value);
    void remove (EventHandler<CopyingFileEventArgs^>^ value);
}

/** @event */
public void add_CopyingFile (EventHandler<CopyingFileEventArgs> value)

/** @event */
public void remove_CopyingFile (EventHandler<CopyingFileEventArgs> value)

JScript supports the use of events, but not the declaration of new ones.

Remarks

This event is fired one time for every 512-KB block that is written to the file.

If the file is less than 512 KB, the event is not raised.

This event is not fired to indicate completion of the file copy operation. Instead, after the file is copied, the AppliedChange event is fired.

The CopyingFileEventArgs class provides the path of the file and the percentage of the file that has been copied.

See Also

Reference

FileSyncProvider Class
FileSyncProvider Members
Microsoft.Synchronization.Files Namespace