Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

XDXMapFile Function

Overview

The XDXMapFile function maps a target object for all XDX engrams and returns an XDX Object. The map can be used to access, add and alter XDX data within the target object.

Syntax/Parameters

Syntax

handle = XDXMapFile ( handle hTarget | string data, [dword mode] );

Parameters

hTarget

A handle to an SGML, Mapped Text or Edit Object. Or,

data

A string containing either a qualified filename or source HTML data.

mode

If data specifies a filename, an optional dword specifying the map flags to use to open the file. See OpenMappedTextFile for information on the flags.

Return Value

A handle to the XDX Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage for additional detail.

Remarks

XDXMapFile is the gateway to most XDX functions by providing a controlled access to the XDX data embedded within an HTML file.

If the source data parameter is an HTML string, the content can only be read.

Related Functions

Platform Support

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

Legato IDE, Legato Basic