Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6d

Application v 6.1b

  

 

Chapter FiveGeneral Functions (continued)

DictionaryIsWord Function

Overview

The DictionaryIsWord function looks up a provided word in a specified dictionary.

Syntax/Parameters

Syntax

boolean = DictionaryIsWord ( string word, [string location] );

Parameters

word

A string containing source word. The string cannot be larger than 512 bytes.

location

An optional string containing location information. The default is “us-en all”.

Return Value

Returns a boolean value as TRUE or FALSE. On failure, FALSE will also be returned but the last error code and string will contain additional data. Use the IsError or IsNotError functions to determine if there was an error and the GetLastError function to retrieve error information.

Remarks

The location parameter specifies which language set to use and which specific dictionary to use. For the current release, only US-English is supported. The format is as follows:

[language] dictionary

Where:

language — Specifies an option language set. At the moment, only “us-en” is supported. If the string is omitted, the function assumes only the dictionary has been specified.

dictionary — Specifies which dictionary to look in. The codes are as follows:

spl — Main Dictionary

abb — Abbreviated Dictionary

hyp — Hyphenated Word Dictionary

cus — Custom Dictionary

nb  — Non-breaking Word Dictionary

ce  — Common Errors Dictionary

all — All Dictionaries (limited)

The default is all.

Related Functions

Platform Support

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

Page revised 2025-08-15