Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter ElevenSGML Functions (continued)

SGMLSetFile Function

Overview

The SGMLSetFile function opens a specified file or URI and maps it for parsing. If a file is specified, it is held open until the object is closed or another data source is loaded.

Syntax/Parameters

Syntax

int = SGMLSetFile ( handle hSGML, string name, [dword mode] );

Parameters

hSGML

A handle to an SGML Object.

name

A string specifying a qualified filename or a valid URI. Note that a invalid URI may not necessarily return an error.

mode

An optional dword specifying the Mapped Text Object options for opening the file. The default value is MFC_ALLOW_TABS.

Return Value

An int specified a ERROR_NONE or a formatted error code.

Remarks

An invalid URI can return a 404 page as the contents on the parse. The parse position is reset to 0,0 and the end range is set the to end of the file.

Unlike SGMLCreate, the SGMLSetFile function allows the access mode to the target file to be controlled.

Related Functions

Platform Support

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

Legato IDE, Legato Basic