GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML 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

CloseHandle — Closes an object handle and releases any associated resources.

SGMLCreate — Creates an SGML Object and optionally attaches a specific object. Use CloseHandle to release.

SGMLGetEditObject — Gets the Edit Object handle (if available).

SGMLGetMappedTextObject — Gets the Mapped Text Object handle (if available).

SGMLNextElement — Gets the next element (skips spaces, text, entities) at the current or specified parse position.

SGMLNextItem — Gets the next item at the current or specified parse position.

SGMLSetHandle — Sets an Edit or Mapped Text Object, or edit window handle, into an existing SGML Object.

SGMLSetString — Sets a string of data into an existing SGML Object.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.