CF_CALLBACK_PARAMETERS structure (cfapi.h)

Contains callback specific parameters such as file offset, length, flags, etc.

Syntax

typedef struct CF_CALLBACK_PARAMETERS {
  ULONG ParamSize;
  union {
    struct {
      CF_CALLBACK_CANCEL_FLAGS Flags;
      union {
        struct {
          LARGE_INTEGER FileOffset;
          LARGE_INTEGER Length;
        } FetchData;
      } DUMMYUNIONNAME;
    } Cancel;
    struct {
      CF_CALLBACK_FETCH_DATA_FLAGS   Flags;
      LARGE_INTEGER                  RequiredFileOffset;
      LARGE_INTEGER                  RequiredLength;
      LARGE_INTEGER                  OptionalFileOffset;
      LARGE_INTEGER                  OptionalLength;
      LARGE_INTEGER                  LastDehydrationTime;
      CF_CALLBACK_DEHYDRATION_REASON LastDehydrationReason;
    } FetchData;
    struct {
      CF_CALLBACK_VALIDATE_DATA_FLAGS Flags;
      LARGE_INTEGER                   RequiredFileOffset;
      LARGE_INTEGER                   RequiredLength;
    } ValidateData;
    struct {
      CF_CALLBACK_FETCH_PLACEHOLDERS_FLAGS Flags;
      PCWSTR                               Pattern;
    } FetchPlaceholders;
    struct {
      CF_CALLBACK_OPEN_COMPLETION_FLAGS Flags;
    } OpenCompletion;
    struct {
      CF_CALLBACK_CLOSE_COMPLETION_FLAGS Flags;
    } CloseCompletion;
    struct {
      CF_CALLBACK_DEHYDRATE_FLAGS    Flags;
      CF_CALLBACK_DEHYDRATION_REASON Reason;
    } Dehydrate;
    struct {
      CF_CALLBACK_DEHYDRATE_COMPLETION_FLAGS Flags;
      CF_CALLBACK_DEHYDRATION_REASON         Reason;
    } DehydrateCompletion;
    struct {
      CF_CALLBACK_DELETE_FLAGS Flags;
    } Delete;
    struct {
      CF_CALLBACK_DELETE_COMPLETION_FLAGS Flags;
    } DeleteCompletion;
    struct {
      CF_CALLBACK_RENAME_FLAGS Flags;
      PCWSTR                   TargetPath;
    } Rename;
    struct {
      CF_CALLBACK_RENAME_COMPLETION_FLAGS Flags;
      PCWSTR                              SourcePath;
    } RenameCompletion;
  } DUMMYUNIONNAME;
} CF_CALLBACK_PARAMETERS;

Members

ParamSize

DUMMYUNIONNAME

DUMMYUNIONNAME.Cancel

DUMMYUNIONNAME.Cancel.Flags

Cancel data flags.

DUMMYUNIONNAME.Cancel.DUMMYUNIONNAME

DUMMYUNIONNAME.Cancel.DUMMYUNIONNAME.FetchData

DUMMYUNIONNAME.Cancel.DUMMYUNIONNAME.FetchData.FileOffset

Offset, in bytes, for specifying the range of data.

DUMMYUNIONNAME.Cancel.DUMMYUNIONNAME.FetchData.Length

Length of the data in bytes.

DUMMYUNIONNAME.FetchData

DUMMYUNIONNAME.FetchData.Flags

Fetch data flags.

DUMMYUNIONNAME.FetchData.RequiredFileOffset

Offset, in bytes, for specifying the required range of data.

DUMMYUNIONNAME.FetchData.RequiredLength

Length of the required data to retrieve, in bytes.

DUMMYUNIONNAME.FetchData.OptionalFileOffset

Offset, in bytes, of a broader piece of data to provide to a sync provider. This is optional and can be used if the sync provider prefers to work with larger segments of data.

DUMMYUNIONNAME.FetchData.OptionalLength

Length, in bytes, of a broader piece of data to provide to a sync provider. This is optional and can be used if the sync provider prefers to work with larger segments of data.

DUMMYUNIONNAME.FetchData.LastDehydrationTime

The system time when the cloud file in question was dehydrated. It is a count of 100-nanosecond intervals since January 1, 1601.

DUMMYUNIONNAME.FetchData.LastDehydrationReason

A member of the CF_CALLBACK_DEHYDRATION_REASON enumeration specifying the reason that the file was last dehydrated.

DUMMYUNIONNAME.ValidateData

DUMMYUNIONNAME.ValidateData.Flags

Data validation flags.

DUMMYUNIONNAME.ValidateData.RequiredFileOffset

Offset, in bytes, for specifying the range of data to validate.

DUMMYUNIONNAME.ValidateData.RequiredLength

Length, in bytes, of the data to validate.

DUMMYUNIONNAME.FetchPlaceholders

DUMMYUNIONNAME.FetchPlaceholders.Flags

Flags for fetching placeholder metadata.

DUMMYUNIONNAME.FetchPlaceholders.Pattern

A standard Windows file pattern which may contain wildcard characters (‘?’, ‘*’). All placeholders information matching the pattern must be transferred, but not necessarily in one-shot, as a minimum requirement. Alternatively, a sync provider may choose to not transfer placeholders matching the pattern.

DUMMYUNIONNAME.OpenCompletion

DUMMYUNIONNAME.OpenCompletion.Flags

Placeholder open completion flags.

DUMMYUNIONNAME.CloseCompletion

DUMMYUNIONNAME.CloseCompletion.Flags

Placeholder close completion flags.

DUMMYUNIONNAME.Dehydrate

DUMMYUNIONNAME.Dehydrate.Flags

Placeholder dehydration flags.

DUMMYUNIONNAME.Dehydrate.Reason

A member of the CF_CALLBACK_DEHYDRATION_REASON enumeration specifying the reason why the placeholder is being dehydrated.

DUMMYUNIONNAME.DehydrateCompletion

DUMMYUNIONNAME.DehydrateCompletion.Flags

Placeholder dehydration completion flags.

DUMMYUNIONNAME.DehydrateCompletion.Reason

A member of the CF_CALLBACK_DEHYDRATION_REASON enumeration specifying the reason why the placeholder was dehydrated.

DUMMYUNIONNAME.Delete

DUMMYUNIONNAME.Delete.Flags

Placeholder deletion flags.

DUMMYUNIONNAME.DeleteCompletion

DUMMYUNIONNAME.DeleteCompletion.Flags

Placeholder deletion complete flags.

DUMMYUNIONNAME.Rename

DUMMYUNIONNAME.Rename.Flags

Rename placeholder flags.

DUMMYUNIONNAME.Rename.TargetPath

The full rename/move target path relative to the volume.

DUMMYUNIONNAME.RenameCompletion

DUMMYUNIONNAME.RenameCompletion.Flags

Rename completion placeholder flags.

DUMMYUNIONNAME.RenameCompletion.SourcePath

The full source link path relative to the volume.

Requirements

Minimum supported client	Windows 10, version 1709 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Header	cfapi.h