IGeoDataServer.ExportReplicaDataChanges Method

Exports data changes for a replica.

[Visual Basic .NET]
Public Function ExportReplicaDataChanges ( _
    ByVal ReplicaName As String, _
    ByVal options As IGDSExportOptions, _
    ByVal TransportType As esriGDSTransportType, _
    ByVal generationsToExport As esriExportGenerationsOption, _
    ByVal switchRole As Boolean _
) As IGDSData

[C#]
public IGDSData ExportReplicaDataChanges (
    string ReplicaName,
    IGDSExportOptions options,
    esriGDSTransportType TransportType,
    esriExportGenerationsOption generationsToExport,
    bool switchRole
);

[C++]
HRESULT ExportReplicaDataChanges(
  BSTR ReplicaName,
  IGDSExportOptions* options,
  esriGDSTransportType TransportType,
  esriExportGenerationsOption generationsToExport,
  VARIANT_BOOL switchRole
);

[C++]
Parameters
ReplicaName [in]

  ReplicaName is a parameter of type BSTR
options [in]

  options is a parameter of type IGDSExportOptions*
TransportType [in]

  TransportType is a parameter of type esriGDSTransportType
generationsToExport [in]

  generationsToExport is a parameter of type esriExportGenerationsOption
switchRole [in]

  switchRole is a parameter of type bool

Product Availability

Remarks

The ExportReplicaDataChanges method is used to export data changes from a replica. Use this method when synchronizing replicas in a disconnected environment. To synchronize replicas in a connected environment, see IReplicationAgent::SynchronizeReplica.

This method should be used in conjunction with the IGeoDataServer::ImportReplicaDataChanges method to complete the transfer of data changes from one replica to it's relative. Note that this method can only be executed for replicas that are data senders. See IGPReplica::ReplicaState for more information.

The ReplicaName is the name of the replica from which to export changes.

The options parameter defines the output of the method. This includes the outut format and whether or not the output will be compressed. See GDSExportOptions for more information.

The TransportType indicates the desired transport type.  Use esriGDSTransportTypeURL to place the output in a file in the virtual output directory. Use esriGDSTransportTypeEmbedded to have the results embedded in the output GDSData object. If no virtual output directory exists, the results will be embedded regardless of the value set for this parameter.

The generationsToExport parameter uses the esriExportGenerationsOption enumeration to specify what data changes to export.  You may choose to export only unacknowledged data change, only new data changes, all data changes, or no data changes. You would export no data changes if you were interested in switching roles (see below). See the esriExportGenerationsOptions enumeration for more information.

Set the switchRole parameter to true if after exporting the data changes, you want to start receiving changes from the relative replica. When set to true, the source replica transitions from a data sender to a data receiver upon export. When the relative replica successfully imports this delta file, it transitions from a data receiver to a data sender.  See the ImportReplicaDataChanges method for more information.

When executed, the method returns a GDSData object. See the GDSData coclass for more information.

See Also