ICopyHelper Interface

Provides access to helper functions for post-processing copied metadata.

Description

This interface can be used to update the metadata of a dataset, a geodatabase, or a standalone XML file after it's been copied. In most cases, explicitly calling this interface isn't necessary, because ArcCatalog will perform this operation for you, as will most programmatic copying methods (i.e. the methods of IGeoDBDataTransfer and IFeatureDataConverter).

Members

Name Description
Method UpdateDatabaseMetadata Call this while creating a copy of a dataset in a geodatabase.
Method UpdateMetadata Call this after creating a copy of a dataset, workspace, or file.

ICopyHelper.UpdateDatabaseMetadata Method

Call this while creating a copy of a dataset in a geodatabase.

Public Sub UpdateDatabaseMetadata ( _
    ByVal destPropertySet As IPropertySet, _
    ByVal src As IDatasetName, _
    ByVal dest As IDatasetName _
)
public void UpdateDatabaseMetadata (
    IPropertySet destPropertySet,
    IDatasetName src,
    IDatasetName dest
);

Description

This method will update the destPropertySet with properties indicating that it is a dataset represented by the dest name object and that it was copied from the dataset represented by the src name object.

Remarks

The metadata properties that are updated depend on which metadata synchronizers are enabled, but typically a new dataqual/lineage/procstep element is added (along with child elements) indicating that the dataset was copied from the pSrc location, and the idinfo/citation/citeinfo/onlink property will be changed if the FGDCSynchronizer is enabled.

As noted in the interface description, it usually isn't necessary to call this method, since most ways of copying a dataset through ArcCatalog and ArcObjects will perform this operation automatically.

Note that unlike the UpdateMetadata method, this will not update the metadata associated with either of the name objects, it will only modify the pDestPropertySet property set (which can then be persisted to the pDest name object through the IMetadata interface).

ICopyHelper.UpdateMetadata Method

Call this after creating a copy of a dataset, workspace, or file.

Public Sub UpdateMetadata ( _
    ByVal src As IName, _
    ByVal dest As IName, _
    ByVal isMove As Boolean _
)
public void UpdateMetadata (
    IName src,
    IName dest,
    bool isMove
);

Description

This method updates the metadata of the dataset represented by the dest name object to indicate that it was copied (or moved) from the dataset represented by the src name object.

Remarks

The metadata properties that are updated depend on which metadata synchronizers are enabled, but typically a new dataqual/lineage/procstep element is added (along with child elements) indicating that the dataset was copied from the pSrc location, and the idinfo/citation/citeinfo/onlink property will be changed if the FGDCSynchronizer is enabled.

As noted in the interface description, it usually isn't necessary to call this method, since most ways of copying a dataset through ArcCatalog and ArcObjects will perform this operation automatically.

Classes that implement ICopyHelper

Classes Description
MetadataCopyHelper Metadata Copy Helper.

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