DCPConfiguration Class

XML Compare .NET API Documentation

XML Compare .NET API Documentation - DEPRECATED

Loads a DocumentComparator from a DCP configuration.

Inheritance Hierarchy

System Object
DeltaXML.CoreS9Api DCPConfiguration

Namespace: DeltaXML.CoreS9Api
Assembly: DeltaXML.CoreS9Api (in DeltaXML.CoreS9Api.dll) Version: 10.4.0.1000 (10.4.0.1000)

Syntax

C++

Copy to Clipboard Print

[ObsoleteAttribute("XML Compare's .NET API is considered deprecated as of version 10.0.0. Please consider using either our Java or REST APIs, and contact DeltaXML for help: https://www.deltaxml.com/contact")]
public class DCPConfiguration

[ObsoleteAttribute("XML Compare's .NET API is considered deprecated as of version 10.0.0. Please consider using either our Java or REST APIs, and contact DeltaXML for help: https://www.deltaxml.com/contact")]
public class DCPConfiguration

<ObsoleteAttribute("XML Compare's .NET API is considered deprecated as of version 10.0.0. Please consider using either our Java or REST APIs, and contact DeltaXML for help: https://www.deltaxml.com/contact")> 
Public Class DCPConfiguration

<ObsoleteAttribute("XML Compare's .NET API is considered deprecated as of version 10.0.0. Please consider using either our Java or REST APIs, and contact DeltaXML for help: https://www.deltaxml.com/contact")> 
Public Class DCPConfiguration

[ObsoleteAttribute(L"XML Compare's .NET API is considered deprecated as of version 10.0.0. Please consider using either our Java or REST APIs, and contact DeltaXML for help: https://www.deltaxml.com/contact")]
public ref class DCPConfiguration

[ObsoleteAttribute(L"XML Compare's .NET API is considered deprecated as of version 10.0.0. Please consider using either our Java or REST APIs, and contact DeltaXML for help: https://www.deltaxml.com/contact")]
public ref class DCPConfiguration

[<ObsoleteAttribute("XML Compare's .NET API is considered deprecated as of version 10.0.0. Please consider using either our Java or REST APIs, and contact DeltaXML for help: https://www.deltaxml.com/contact")>]
type DCPConfiguration =  class end

[<ObsoleteAttribute("XML Compare's .NET API is considered deprecated as of version 10.0.0. Please consider using either our Java or REST APIs, and contact DeltaXML for help: https://www.deltaxml.com/contact")>]
type DCPConfiguration =  class end

Remarks

Loads a DocumentComparator from a DCP configuration.

DCP (Document Comparator Pipeline) is a declarative file format for describing a configuration for a DocumentComparator. Further information on the DCP format and usage is available in the Online Document Comparator Configuration using DCP.

This class provides methods for obtaining information from DCP files and also for generating a DocumentComparator instance configured from DCP. Parameter overrides for the default DCP configuration can be supplied when the DocumentComparator is first generated using the 'generate' method, they can also be supplied subsequently using the 'setParams' method.

The class constructor optionally allows a 'checkDCP' argument that can be set false to disable validation of the DCP. This may improve performance, but results in less informative exception messages. It is therefore recommended that this is only used for cases where the DCP file and any parameter overrides are already known to be valid.