Interface ISynchronizationHelper
- Namespace
- ESRI.ArcGIS.Geodatabase
- Assembly
- ESRI.Server.Geodatabase.dll
Provides access to helper functions for metadata synchronization.
[Guid("7002C8B5-1D00-11D3-A63B-0008C7D3AE50")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ISynchronizationHelper
Remarks
ISynchronizationHelper may still be used to write FGDC format metadata, if desired. You may use any of the Populate or Extract methods to force specific aspects of the metadata to be synchronized. The methods
whose names begin Populate… write information into the metadata that relates to the processing environment, such as the version of ArcGIS software that is being used. The Extract… methods take an input object such as IRelationshipClass and write properties of this object into the metadata. Calls to the Extract or Populate methods should be preceded by StartSynchronization and proceeded by FinishSynchronization.
Most ArcObjects code will not need to use this interface, as it's already called by other ArcObjects components when needed.
Methods
ExtractBriefEntityAttrProperties(IClass, int, IPropertySet)
Extracts brief entity attribute properties from a Feature Class.
void ExtractBriefEntityAttrProperties(IClass geoDataset, int Index, IPropertySet PropertySet)
Parameters
geoDatasetIClassIndexintPropertySetIPropertySet
ExtractBriefRelationshipProperties(IRelationshipClass, int, IPropertySet)
Extracts brief entity attribute properties from a Relationship Class.
void ExtractBriefRelationshipProperties(IRelationshipClass RelationshipClass, int Index, IPropertySet PropertySet)
Parameters
RelationshipClassIRelationshipClassIndexintPropertySetIPropertySet
ExtractEntityAttrProperties(IClass, int, IPropertySet)
Extracts entity attribute properties from a Feature Class.
void ExtractEntityAttrProperties(IClass geoDataset, int Index, IPropertySet PropertySet)
Parameters
geoDatasetIClassIndexintPropertySetIPropertySet
ExtractFeatureClassProperties(IFeatureClass, int, IPropertySet)
Extracts properties from a Feature Class.
void ExtractFeatureClassProperties(IFeatureClass geoDataset, int Index, IPropertySet PropertySet)
Parameters
geoDatasetIFeatureClassIndexintPropertySetIPropertySet
ExtractRelationshipProperties(IRelationshipClass, int, IPropertySet)
Extracts entity attribute properties from a Relationship Class.
void ExtractRelationshipProperties(IRelationshipClass RelationshipClass, int Index, IPropertySet PropertySet)
Parameters
RelationshipClassIRelationshipClassIndexintPropertySetIPropertySet
ExtractSpatialProperties(IGeoDataset, IPropertySet)
Extracts spatial properties from a GeoDataset.
void ExtractSpatialProperties(IGeoDataset geoDataset, IPropertySet PropertySet)
Parameters
geoDatasetIGeoDatasetPropertySetIPropertySet
FinishSynchronization(IPropertySet)
Call this after synchronizing.
void FinishSynchronization(IPropertySet PropertySet)
Parameters
PropertySetIPropertySet
Remarks
FinishSynchronization indicates that the synchronization process is complete. Changes to the XML property set that occurred during synchronization are saved in the metadata document.
PopulateDistributionProperties(string, string, IPropertySet)
Populates distribution properties given a filename.
void PopulateDistributionProperties(string fileName, string fileType, IPropertySet PropertySet)
Parameters
fileNamestringfileTypestringPropertySetIPropertySet
PopulateDistributionPropertiesForDatabase(IDataset, IPropertySet)
Populates distribution properties given a filename.
void PopulateDistributionPropertiesForDatabase(IDataset Dataset, IPropertySet PropertySet)
Parameters
DatasetIDatasetPropertySetIPropertySet
PopulateStaticProperties(IPropertySet)
Fills in required properties.
void PopulateStaticProperties(IPropertySet PropertySet)
Parameters
PropertySetIPropertySet
StartSynchronization(IPropertySet, esriMetadataSyncAction, int, out bool)
Call this before synchronizing.
void StartSynchronization(IPropertySet PropertySet, esriMetadataSyncAction action, int interval, out bool Ok)
Parameters
PropertySetIPropertySetactionesriMetadataSyncActionintervalintOkbool
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.