Share via


CopyingFileEventArgs Class

Provides data for the CopyingFile event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.Synchronization.Files.CopyingFileEventArgs

Namespace:  Microsoft.Synchronization.Files
Assembly:  Microsoft.Synchronization.Files (in Microsoft.Synchronization.Files.dll)

Syntax

'Declaration
Public Class CopyingFileEventArgs _
    Inherits EventArgs
'Usage
Dim instance As CopyingFileEventArgs
public class CopyingFileEventArgs : EventArgs
public ref class CopyingFileEventArgs : public EventArgs
type CopyingFileEventArgs =  
    class
        inherit EventArgs
    end
public class CopyingFileEventArgs extends EventArgs

The CopyingFileEventArgs type exposes the following members.

Properties

  Name Description
Public property FilePath Gets the path of the file that is being copied. The path is relative to the root directory.
Public property PercentCopied Gets the progress of the copy operation. The value is returned as a percentage.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Remarks

To communicate progress while copying a file, the CopyingFile event occurs periodically while a change is being applied to the destination replica.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Synchronization.Files Namespace