GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

SGMLGetEntryProperties Function

Overview

The SGMLGetEntryProperties function returns the properties for a specific parameter entry within an SGML Object in the form of a string array.

Syntax/Parameters

Syntax

string [] = SGMLGetEntryProperties ( handle hSGML, int index );

Parameters

hSGML

A handle to an SGML Object.

index

An int specifying the zero-based index position of the entry.

Return Value

A string array containing an entry for each property or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

If the property name cannot be translated, the value 0x1002 will be ORed bitwise with the error code.

Remarks

Each parameter within the SGML object will have the following named key items:

	Key Name		Description
	parameter_token		A hexadecimal string representing the token value for the entry.
	parameter		The parameter string as translated from the attribute or property token or as a raw string.
	pvalue		A hexadecimal string representing the pvalue for the data associated with the entry.
	namespace_token		A hexadecimal string representing the namespace token value for the entry.
	namespace		The namespace as translated from the namespace token or as a raw string.
	x_position		A decimal string presenting the character position to the parameter position within the incoming data. Any returns are counted as one space.
	x_offset		A decimal string presenting the relative X offset to the parameter position within the incoming data.
	y_offset		A decimal string presenting the relative Y offset to the parameter position within the incoming data.
	flags		A hexadecimal string representing the flags for the entry.

 

Related Functions

SGMLGetEntryCount — Returns the number of entries in the parameter list.

SGMLGetEntryFlags — Returns the flags for a specified parameter by index.

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.

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 10/21/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.