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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

FieldSetParameter Function

Overview

The FieldSetParameter function sets a parameter into a Field Object.

Syntax/Parameters

Syntax

int = FieldSetParameter ( handle hField, string param | dword param,
                                     string value | dword value | int value );

Parameters

hField

A handle to a Field Object.

param

A string or a dword specifying the name of a known parameter or a token for a parameter.

value

A string, dword or int as the value for the parameter. If the value is a string, it is added after encoding. If it is a dword it is added as a string in hex form (0x00000000) and finally if it is an int it is added as string in signed 32-bit integer form.

Return Value

An int as ERROR_NONE or a formatted error code on failure.

Remarks

A field set can have a maximum of 48 parameters.

Related Functions

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

FieldGetFieldProperties — Returns all properties associated with a field.

FieldGetParameter — Gets the value for a specified parameter as a string or token.

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

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

FieldReset — Resets the Field Object and sets a specific token type to create a new field.

FieldToParameters — Parses a supplied field in a string and returns a list of parameters.

FieldToString — Creates a string version of the current field object.

FieldWrite — Writes the current field back to the source 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.