ISynchronizationHelper.StartSynchronization Method

Call this before synchronizing.

[Visual Basic .NET]
Public Sub StartSynchronization ( _
    ByVal PropertySet As IPropertySet, _
    ByVal action As esriMetadataSyncAction, _
    ByVal interval As Integer, _
    ByRef Ok As Boolean _
)

[C#]
public void StartSynchronization (
    IPropertySet PropertySet,
    esriMetadataSyncAction action,
    int interval,
    ref bool Ok
);

[C++]
HRESULT StartSynchronization(
  IPropertySet* PropertySet,
  esriMetadataSyncAction action,
  long interval,
  VARIANT_BOOL* Ok
);

[C++]
Parameters
PropertySet [in]
  PropertySet is a parameter of type IPropertySet
action [in]
  action is a parameter of type esriMetadataSyncAction
interval [in]
  interval is a parameter of type long
Ok [out]
  Ok is a parameter of type VARIANT_BOOL

Product Availability

Remarks

As with the IMetadata::Synchronize method, StartSynchronization uses the options defined in esriMetadataSyncAction to specify whether metadata will be created and elements will be modified based on whether or not the metadata already exists.

The interval parameter allows a minimum time (in seconds) to be provided between modifications. For example, if the interval parameter is set to 1000 when this method is called, the modification time of the property set will be checked, and if the difference between it and the current time is less than 1000 seconds, the synchronization "helping" will not begin (and the outbound Ok parameter will be set to false).

Ok indicates whether or not the synchronization helper was able to begin successfully.

See Also