Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter ElevenSGML Functions (continued)

CompareHTMLGetFirstDifference Function

Overview

The CompareHTMLGetFirstDifference function compares a base HTML file to a revised HTML file and generates a list of insertions and deletions. If the files differthe function returns a handle to Compare HTML Enumeration Object.

Syntax/Parameters

Syntax

handle = CompareHTMLGetFirstDifference ( string base, string revised, [boolean casing],
                                    [boolean spaces], [boolean styles],
                                    [boolean entities], [boolean coding] );

Parameters

base

A string to a qualified filename of the base file.

revised

A string to a qualified filename of the revised file.

casing

A boolean indicating whether the result should show changes in letter casing. Default value is false.

spaces

A boolean indicating whether the result should show changes in white spacing. Default value is false.

styles

A boolean indicating whether the result should show changes in styling. Default value is false.

entities

A boolean indicating whether the result should show changes in character entity values. Default value is false.

coding

A boolean indicating whether the result should show changes in HTML tag coding. Default value is false.

Return Value

Returns a handle to a Compare HTML Enumeration Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information.

Remarks

For more information on the comparison options see the CompareHTMLCreateMerged function documentation.

The Compare HTML Object returned by the CompareHTMLGetFirstDifference function contains the first difference between the base and revised files. The properties of the item can be retrieved with functions such as the CompareHTMLGetDifferenceProperties function. To move to the next entry in the folder, use the CompareHTMLGetNextDifference function.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE