Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter SeventeenApplication Integration Functions (continued)

MenuFindFunctionIndex Function

Overview

The MenuFindFunctionIndex function searches the function library for a specific function code by string and returns its function index within the function table.

Syntax/Parameters

Syntax

int = MenuFindFunctionIndex ( 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 index corresponding to code or -1 on failure. Use the GetLastError function to retrieve error information. 

Remarks

The function index can be used to reference other function characteristics directly from the function table. The index is not the Function ID.

Avoid repetitively finding indices which can slow script operation. For example, a hook script should look up the function index 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

Page revised 2024-12-13