CommonComparator.compare Method (Stream, Uri, Stream, Uri, Stream)

CommonComparator compare Method (Stream, Uri, Stream, Uri, Stream)

XML Compare .NET API Documentation

XML Compare .NET API Documentation - DEPRECATED

Compares two XML Streams and provides the result in a Stream

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

Syntax

C++

Copy to Clipboard Print

public void compare(
	Stream a,
	Uri systemIdA,
	Stream b,
	Uri systemIdB,
	Stream result
)

public void compare(
	Stream a,
	Uri systemIdA,
	Stream b,
	Uri systemIdB,
	Stream result
)

Public Sub compare ( 
	a As Stream,
	systemIdA As Uri,
	b As Stream,
	systemIdB As Uri,
	result As Stream
)

Public Sub compare ( 
	a As Stream,
	systemIdA As Uri,
	b As Stream,
	systemIdB As Uri,
	result As Stream
)

public:
void compare(
	Stream^ a, 
	Uri^ systemIdA, 
	Stream^ b, 
	Uri^ systemIdB, 
	Stream^ result
)

public:
void compare(
	Stream^ a, 
	Uri^ systemIdA, 
	Stream^ b, 
	Uri^ systemIdB, 
	Stream^ result
)

member compare : 
        a : Stream * 
        systemIdA : Uri * 
        b : Stream * 
        systemIdB : Uri * 
        result : Stream -> unit

member compare : 
        a : Stream * 
        systemIdA : Uri * 
        b : Stream * 
        systemIdB : Uri * 
        result : Stream -> unit

Parameters

a: Type: System.IO Stream
The stream providing the first input

systemIdA: Type: System Uri
A systemId used to locate relative references in input a and for error reporting

b: Type: System.IO Stream
The stream for the second input

systemIdB: Type: System Uri
A systemId used to locate relative references in input b and for error reporting

result: Type: System.IO Stream
The stream where the pipeline result will be written

Exceptions

Exception	Condition
com.deltaxml.cores9api ComparisonException	Thrown if there is a problem during the comparison stage of the pipeline
com.deltaxml.cores9api FilterProcessingException	Thrown if there was a problem running any of the filters
com.deltaxml.cores9api PipelineLoadingException	Thrown if the inputs cannot be loaded or parsed
com.deltaxml.cores9api PipelineSerializationException	Thrown if the input cannot be saved or serialized to the result location
com.deltaxml.cores9api LicenseException	Thrown if there is a licensing issue that prevents operation
com.deltaxml.core PipelinedComparatorError	Thrown if a comparator execution thread is interrupted by another thread

Remarks

systemId parameters are provided so that relative URIs can be resolved in the inputs, they are also useful when reporting errors as the systemId may be useful when locating the error position. Using identifiers such as "string1" or "database2" may be useful when the inputs do not contain URIs to resolve as they appear in error messages and can aid error diagnosis.