Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter Twenty-threeXBRL Functions (continued)

XDXCreateTransactionLog Function

Overview

The XDXCreateTransactionLog function reads XDX source data and creates an XDX Transaction Log or XTL file.

Syntax/Parameters

Syntax

int = XDXCreateTransactionLog ( string source | handle hSource,
                            string destination, [dword flags]) );

Parameters

source

A string specifying a qualified filename. Or,

hSource

A handle to a Mapped Text Object or an Edit Object.

destination

A string specifying the destination for the XTL file.

options

An optional dword specifying output and processing options. If not supplied, the default value will be:

XT_ERROR_LEVEL_HIGH | XT_DISPLAY_PROGRESS

Return Value

An int as a formatted error code. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage for additional detail.

Remarks

A transaction log can be created from any well formed XDX coded document. The options are as follows:

  Define   Bitwise   Description  
  XDX_XTL_SORTED   0x00000010   Sort Data  
  XDX_XTL_SORTED_MASK   0x0000000F   Sorted Mask  
  XDX_XTL_KEY_ELEMENT   0x00000000   Element Key  
  XDX_XTL_KEY_CONTEXT   0x00000001   Context Key  
  XDX_XTL_KEY_OPTIMIZED   0x00000002   Optimized Key  
  XDX_XTL_CHANGES_ONLY   0x00010000   Write Only Changes  
  XDX_XTL_ADD_ELE_ARRAY   0x00020000   Add Element Array as Comment  
  XDX_XTL_ADD_UNITDEFS   0x00040000   Add Unit Definitions  
  XDX_XTL_NO_DATA   0x00100000   No Data  

 

See Appendix G — XDX Transaction Log Specification for the syntax of an XTL file.

Related Functions

Platform Support

GoFiler Complete, GoFiler Corporate, GoXBRL