IMetadataSynchronizerManager Interface

Provides access to members that control which metadata synchronizers are used to update metadata.

Description

The IMetadataSynchronizationManagerinterface**is used to manage the synchronization objects registered in ArcCatalog. Three methods, (GetEnabled, GetSynchronizer, and SetEnabled) and one property (NumSynchronizers**) are supported through this interface.

When To Use

TheIMetadataSynchronizationManager is used when changing the current synchronizers that are enabled, when attempting to retrieve a specific synchronizer, or after creating a custom metadata synchronizer. The interface allows enabling or disabling any of the registered metadata sychronizers. A synchronizer's enabled status determines whether it will write metadata when the synchronization process occurs.

Members

Name Description
Method GetEnabled Indicates whether the Nth synchronizer is enabled.
Method GetSynchronizer Gets the nth synchronizer.
Read-only property NumSynchronizers The number of available synchronizers.
Method SetEnabled Set the synchronizer to be enabled or disabled.

IMetadataSynchronizerManager.GetEnabled Method

Indicates whether the Nth synchronizer is enabled.

Public Function GetEnabled ( _
    ByVal Index As Integer _
) As Boolean
public bool GetEnabled (
    int Index
);

Description

The GetEnabledmethod returns a boolean if the metadata sychronizer, specified using the index parameter, is currently enabled.

IMetadataSynchronizerManager.GetSynchronizer Method

Gets the nth synchronizer.

Public Function GetSynchronizer ( _
    ByVal Index As Integer _
) As IMetadataSynchronizer
public IMetadataSynchronizer GetSynchronizer (
    int Index
);

Remarks

The GetSynchronizer method provides a reference to the IMetadataSynchronizer object.

Because the GetSynchronizer method uses an index to get the desired synchronizer, the IMetadataSynchronizerManager::NumSynchronizers property and IMetadataSynchronizer::Name are often used to first specify the metadata sychronizer of choice.

IMetadataSynchronizerManager.NumSynchronizers Property

The number of available synchronizers.

Public ReadOnly Property NumSynchronizers As Integer
public int NumSynchronizers {get;}

Description

Returns the number of metadata synchronizers registered on the machine.

IMetadataSynchronizerManager.SetEnabled Method

Set the synchronizer to be enabled or disabled.

Public Sub SetEnabled ( _
    ByVal Index As Integer, _
    ByVal Enabled As Boolean _
)
public void SetEnabled (
    int Index,
    bool Enabled
);

Description

The SetEnabledmethod sets the enabled/disabled state of the synchronizer referenced by the index passed in to the first argument.

Remarks

The Indexparameter is used to indicate the specific metadata synchronizer.

The second argument, of data type boolean, sets the state of the synchronizer.

Note that enabling and disabling synchronizers through this interface is persisted _across_sessions. If changes are meant to be temporary, it's recommended that the current enabled status of each synchronizer be stored prior to any changes being made, then restored after.

Classes that implement IMetadataSynchronizerManager

Classes Description
MetadataSynchronizer Esri Metadata Synchronizer object (singleton).

Remarks

The IMetadataSynchronizerManagerInterface is available from the MetadataSynchronizer CoClass. The interface allows you to enable or disable any of the registered metadata synchronizers.

Additional information on this subject can be found in the Technical Paper "Creating a Custom Metadata Synchronizer", May 2001.

Note that enabling and disabling synchronizers through this interface is persisted _across_sessions. If changes are meant to be temporary, it's recommended that the current enabled status of each synchronizer be stored prior to any changes being made, then restored after.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.