Share via


IFileSyncProvider::SetPreviewMode

Sets a value that indicates whether the provider is in preview mode.

Syntax

HRESULT SetPreviewMode(
  BOOL fPreviewMode);

Parameters

  • fPreviewMode
    [in] TRUE to put the provider in preview mode; otherwise, FALSE.

Return Value

Remarks

If the provider is in preview mode, all synchronization actions will be performed as if for an actual synchronization session; however, no changes will be applied. This means that progress notifications will still be sent out for changes that would have been applied and change detection will be performed. Because of this, using preview mode could potentially be an expensive operation.

For more information about how to use preview mode to show incremental synchronization progress to the user, see Reporting File Synchronization Progress.

See Also

Reference

IFileSyncProvider Interface