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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

FieldGetParameter Function

Overview

The FieldGetParameter function scans the current field object for a specific property name and returns the value.

Syntax/Parameters

Syntax

string = FieldGetParameter ( handle hField, string name | dword token );

Parameters

hField

A handle to a Field Object.

name

A string containing a parameter name to find. If the name cannot be translated to a known token, a ERROR_RANGE error will be returned. Or,

token

A dword containing a parameter name token value.

Return Value

A string containing the contents of the parameter or an empty string on error. Use the GetLastError function to retrieve a formatted error code. Since the parameter can be specified but empty, an empty string can be a valid value.

Remarks

If the name parameter cannot be translated, ERROR_RANGE will be placed in the last error buffer.

Related Functions

FieldCreateObject — Creates a Field Object from an SGML, Mapped Text or Edit Object.

FieldFindField — Finds a specific field by token or name from the current or specified parse point.

FieldGetFieldProperties — Returns all properties associated with a field.

FieldGetFieldToken — Returns the field token value.

FieldGetParameters — Returns an array of all parameters as key names and values.

FieldGetParseString — Returns a copy of the parse buffer from the last parse action.

FieldNextField — Scans forward from the current or specified position to locate a field.

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.