CopyFileRange Event

Fires when the OS needs to copy a range of data from one file to another.

Syntax

• C#
• VB.NET

public event OnCopyFileRangeHandler OnCopyFileRange;

public delegate void OnCopyFileRangeHandler(object sender, FuseCopyFileRangeEventArgs e);

public class FuseCopyFileRangeEventArgs : EventArgs {
  public string PathIn { get; }
  public int FileContextIn { get; }
  public long OffsetIn { get; }
  public string PathOut { get; }
  public int FileContextOut { get; }
  public long OffsetOut { get; }
  public long Size { get; }
  public int Flags { get; }
  public int Result { get; set; }
}

Public Event OnCopyFileRange As OnCopyFileRangeHandler

Public Delegate Sub OnCopyFileRangeHandler(sender As Object, e As FuseCopyFileRangeEventArgs)

Public Class FuseCopyFileRangeEventArgs Inherits EventArgs
  Public ReadOnly Property PathIn As String
  Public ReadOnly Property FileContextIn As Integer
  Public ReadOnly Property OffsetIn As Long
  Public ReadOnly Property PathOut As String
  Public ReadOnly Property FileContextOut As Integer
  Public ReadOnly Property OffsetOut As Long
  Public ReadOnly Property Size As Long
  Public ReadOnly Property Flags As Integer
  Public Property Result As Integer
End Class

Remarks

Windows:

This event is currently not used.

Linux:

This event fires when the OS needs to copy a range of data from one file to another. The source file is identified either by PathIn or FileContextIn. The destination file is identified either by PathOut or FileContextOut.

OffsetIn specifies the starting offset in the source file from which the data is taken.

OffsetOut specifies the starting offset in the destination file, to which the data should be written.

Size specifies the size of the data block to be copied.

Flags is provided for future extensions and is currently not used.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a negative error code value (e.g. -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.