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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

SGMLPullParameterValue Function

Overview

The SGMLPullParameterValue function “pulls” a parameter from the SGML Object and returns the data as a formatted dword value (PVALUE). The attribute or CSS property can be specified as a string or as a token.

Syntax/Parameters

Syntax

PVALUE = SGMLPullParameterValue ( handle hSGML, TOKEN token | string property );

Parameters

hSGML

A handle to an SGML Object.

token

An optional TOKEN (dword) as a token value for an attribute or CSS property. The token must be defined in the DTD. Or,

property

An optional string specifying a text version of the attribute or CSS property. The property is tested as an attribute and then as a CSS property name. If not found in the DTD, an error is returned. Either the token or property parameter must be provided.

Return Value

A PVALUE (dword) containing the value for the specified attribute/property or 0x00000000 on error. Because a value can legitimately be zero, the GetLastError or IsError function must be used to determine if an error occurs.

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

Remarks

An element must be selected in the SGML Object to have any parameters loaded.

The pull functions get the data and then mark the item as deleted. This can be useful in indicating a parameter has been processed.

Certain types that store data on the heap (ie., strings or CDATA) will return a pvalue type with a heap index.

For HTML, all inline CSS styles parameters are automatically loaded and processed. The ‘STYLE’ attribute is not available for direct reading.

When specifying a CSS property name, adding the prefix ‘+’ will force the name to be translated as only CSS. There are some CSS and HTML attributes with the same name such as ‘color’.

The SGMLGetParameterFlags function can be used to retrieve additional properties about the parameter.

Related Functions

SGMLGetParameterFlags — Returns the parameter flags.

SGMLGetParameter — Gets a specified parameter (attribute/CSS) as a string.

SGMLGetParameterValue — Gets a specified parameter as a pvalue.

SGMLGetParameters — Returns all the parameters in the form of a string list.

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.

SGMLPullParameter — Gets a specified parameter as a string and removes it from the object.

SGMLStringToValue — Converts a string to pvalue type.

SGMLValueToString — Converts a pvalue type to a string.

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.