BinaryDocument object

 

 

Prototype for BinaryDocument objects

Syntax

To create a BinaryDocument do this:

var parameters = new Document.Parameters ( );
parameters.document_type = "binaries";

var doc = new Document (parameters, "view");

Parameters

none. Use Document constructor.

Property Of

none.

Implemented In

ECMerge 2.4

Description

BinaryDocument are the documents used to compare binary files. They are currently read-only. They allow you to determine precisely how two or three documents compare which differences are present between the pairs of files. The BinaryDocument let you access the content of any file in numerical manner with BinaryDocument.Content.read_number .

Properties

Property	Description
zones_of_interest	Array of BinaryDocument.ZoneOfInterest objects. Read-Only. Zones of interest are bands of bytes which are naturally confronted given the differences at hand.
content	Array of BinaryDocument.Content objects. Read-Only. Content objects are the files loaded by the comparison engine.
information	See description in Document object.

 

Properties of information[side]

Property	Description
dynamic_fields	Array of BinaryDocument.Field objects. Read-only. List of fields discovered by the script 'dynamic fields script' in the binary file type for that role

 

Methods

differences
finalize_differences

See Also 

  BinaryDocument.Content object

 

Method differences

Syntax

function differences ( couple )
returns an Array of BinaryDocument.Difference object.

Parameters

couple. Side Couple string. Couple for which the differences are requested. In 2-way, only "left-right" is legal.

Method Of

TextDocument object.

Implemented In

ECMerge 2.1

Description

Returns a Array of differences describing the left side in the given couple was modified with respect to the other side of the couple.

Examples

Example 1.

Displays a message box telling whether the two sides are identical or not:

var doc = current_frame.coordinator.document;
alert ( "Left and right sides are "+ (doc.differences ("left-right").length == 0 ? "identical" : "different") );

See Also 

BinaryDocument.Difference object

Method finalize_differences

Syntax

function finalize_differences ( )

Parameters

none.

Method Of

BinaryDocument object.

Implemented In

ECMerge 2.4

Description

This method forces the comparison engine to compute all the differences. 

See Also 

BinaryDocument.Difference object