Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ElevenSGML Functions (continued)

FieldDeleteParameter Function

Overview

The FieldDeleteParameter function scans the current field object for a specific property name and deletes it, if it exists.

Syntax/Parameters

Syntax

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

Parameters

hField

A handle to a Field Object.

name

A string containing a parameter name to delete. 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

An int as index of the parameter or a formatted error code on error.

Remarks

Attempting to delete a parameter that does not exist does not alter the field object.

Related Functions

Platform Support

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

Legato IDE, Legato Basic