Share via


IMetadataStoreUpgradeCallback::OnMetadataStoreFileUpgradeStart

Called by Sync Framework before the metadata store file format is upgraded. Returns a value that indicates whether the upgrade can be performed.

HRESULT OnMetadataStoreFileUpgradeStart(
  BOOL *pfSkipUpgrade);

Parameters

  • pfSkipUpgrade
    [out] Returns TRUE when the upgrade cannot be performed. Otherwise, FALSE.

Return Value

  • S_OK

  • Provider-determined error codes

Remarks

Sync Framework automatically upgrades metadata store files that are in the 1.0 format to the 2.0 format, unless an IMetadataStoreUpgradeCallback object is registered before the metadata store is opened, and OnMetadataStoreFileUpgradeStart sets pfSkipUpgrade to TRUE. Be aware that a file in the 2.0 format cannot be reverted to the 1.0 format.

See Also

Reference

IMetadataStoreUpgradeCallback Interface