Share via

IProviderUpgradeCallback.OnProviderUpgradeRequired Method

  • Article

Occurs when the expected provider compatibility version specified to DeserializeReplicaMetadata does not match the provider version that is contained in the serialized metadata.

Namespace:  Microsoft.Synchronization.MetadataStorage
Assembly:  Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)

Syntax

'Declaration
Sub OnProviderUpgradeRequired ( _
    dwCurrentProviderVersionInFile As UInteger _
)
'Usage
Dim instance As IProviderUpgradeCallback
Dim dwCurrentProviderVersionInFile As UInteger

instance.OnProviderUpgradeRequired(dwCurrentProviderVersionInFile)

void OnProviderUpgradeRequired(
    uint dwCurrentProviderVersionInFile
)

void OnProviderUpgradeRequired(
    unsigned int dwCurrentProviderVersionInFile
)

abstract OnProviderUpgradeRequired : 
        dwCurrentProviderVersionInFile:uint32 -> unit 

function OnProviderUpgradeRequired(
    dwCurrentProviderVersionInFile : uint
)

Parameters

  • dwCurrentProviderVersionInFile
    Type: System.UInt32
    The provider version that is contained in the serialized metadata.

Remarks

If the provider cannot upgrade the metadata from the version specified by dwCurrentProviderVersionInFile, this method must throw an exception, such as MetadataStoreProviderVersionMismatchException.

See Also

Reference

IProviderUpgradeCallback Interface

Microsoft.Synchronization.MetadataStorage Namespace