IGeoDataServer.ExtractData Method

Extract Data.

[Visual Basic .NET]
Public Function ExtractData ( _
    ByVal versionName As String, _
    ByVal replicaDesc As IGPReplicaDescription, _
    ByVal options As IGDSExportOptions, _
    ByVal TransportType As esriGDSTransportType _
) As IGDSData

[C#]
public IGDSData ExtractData (
    string versionName,
    IGPReplicaDescription replicaDesc,
    IGDSExportOptions options,
    esriGDSTransportType TransportType
);

[C++]
HRESULT ExtractData(
  BSTR versionName,
  IGPReplicaDescription* replicaDesc,
  IGDSExportOptions* options,
  esriGDSTransportType TransportType,
  IGDSData** result
);

[C++]

Parameters
versionName [in]
  versionName is a parameter of type BSTR
replicaDesc [in]

  replicaDesc is a parameter of type IGPReplicaDescription
options [in]

  options is a parameter of type IGDSExportOptions
TransportType [in]

  TransportType is a parameter of type esriGDSTransportType
result [out, retval]

  result is a parameter of type IGDSData

Product Availability

Remarks

The extractData method extracts schema and data from the geodatabase represented by the GeoDataServer in a disconnected environment. To extract data in a connected environment, see IReplicationAgent::ExtractData.

If the GeoDataServer references an ArcSDE geodatabase, the versionName parameter defines the version from which the data will be extracted. 

The replicaDesc parameter is a description of the data to extract as well as various settings that define how the data will be extracted.  For example, you can set a spatial filter and specify whether or not to include related data.  See the GPReplicaDescription coclass for more information. 

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.

If exporting to XML or FileGDBTransport, the output of this method can be used with the ImportData method to import the data into a destination geodatabase. If exporting to a file geodatabase or personal geodatabase, the output geodatabase can be used directly. 

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.

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

See Also