Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter SeventeenApplication Integration Functions (continued)

MenuFindFunctionID Function

Overview

The MenuFindFunctionID function searches the function library for a specific function code by string and returns its Function ID (number).

Syntax/Parameters

Syntax

int = MenuFindFunctionID ( string code );

Parameters

code

A string containing the specific code for a function (for example, “EDGAR_SUBMIT_TEST”).

Return Value

Returns an int containing the Function ID corresponding to code or -1 on failure. Use the GetLastError function to retrieve error information. 

Remarks

Scripts should not rely on numeric Function ID values since they may change between versions of applications. To maintain compatibility between versions, use the MenuFindFunctionID function to lookup the ID associated with the string function code. The numeric ID can then be used for hooks and other menu functions.

Avoid repetitively finding IDs which can be slow script operation. For example, a hook script should look up the function IDs it requires during the setup process and store them as global values for later comparison.

Related Functions

Platform Support

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

Legato IDE, Legato Basic