Share via

IFileSyncProviderCallback::OnChangeSkipped

  • Article

Occurs when a change is skipped.

HRESULT OnChangeSkipped(
  LPCWSTR pcszNewFilePath,
  LPCWSTR pcszCurrentFilePath,
  DWORD dwChangeType,
  DWORD dwReason,
  HRESULT hrErrorCode);

Parameters

  • pcszNewFilePath
    [in, string] The new path that the file would have if the change were applied. The path is relative to the root directory. If dwChangeType is FILESYNC_CHANGE_TYPE_RENAME, this is the path after the new name would have been applied. If dwChangeType is FILESYNC_CHANGE_TYPE_DELETE, this value is NULL.
  • pcszCurrentFilePath
    [in, string] The current path for the file. The path is relative to the root directory. If dwChangeType is FILESYNC_CHANGE_TYPE_RENAME, this is the path before the new name would have been applied. If dwChangeType is FILESYNC_CHANGE_TYPE_CREATE, this value is NULL.
  • dwChangeType
    [in] The type of change that would have been applied. This value is from the FILESYNC_CHANGE_TYPE enumeration.
  • dwReason
    [in] The reason the change could not be applied to the file. This value is from the FILESYNC_SKIP_REASON enumeration.
  • hrErrorCode
    [in] An error code that was returned by a function during the attempt to apply the change to the file, if an error code was returned. An error that is contained in this parameter will typically be returned by the file system to indicate that a problem has occurred while applying the change, such as a failure to obtain write access to the file.

Return Value

  • S_OK

Remarks

If OnChangeSkipped returns an error, Sync Framework stops processing the current change batch and returns the error code from the ProcessChangeBatch method of IFileSyncProvider.

See Also

Reference

IFileSyncProviderCallback Interface
FILESYNC_SKIP_REASON Enumeration