CopyFileRange Event

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

Syntax

• C++

ANSI (Cross Platform)
virtual int FireCopyFileRange(FUSECopyFileRangeEventParams *e);

typedef struct {
  const char *PathIn;
  int FileContextIn;
  int64 OffsetIn;
  const char *PathOut;
  int FileContextOut;
  int64 OffsetOut;
  int64 Size;
  int Flags;
  int Result;
  int reserved;
} FUSECopyFileRangeEventParams;

Unicode (Windows)
virtual INT FireCopyFileRange(FUSECopyFileRangeEventParams *e);

typedef struct {
  LPCWSTR PathIn;
  INT FileContextIn;
  LONG64 OffsetIn;
  LPCWSTR PathOut;
  INT FileContextOut;
  LONG64 OffsetOut;
  LONG64 Size;
  INT Flags;
  INT Result;
  INT reserved;
} FUSECopyFileRangeEventParams;

#define EID_FUSE_COPYFILERANGE 4

virtual INT CBFSFUSE_CALL FireCopyFileRange(LPWSTR &lpszPathIn, INT &iFileContextIn, LONG64 &lOffsetIn, LPWSTR &lpszPathOut, INT &iFileContextOut, LONG64 &lOffsetOut, LONG64 &lSize, INT &iFlags, INT &iResult);

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.