GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Seventeen — Application 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

MenuAddFunction — Adds a function to the application function list.

MenuEnumerateFunctions — Returns a table of all of properties for all functions.

MenuFindFunctionIndex — Finds a function’s table index by Function Code.

MenuGetFunctionCode — Gets the Function Code (string) by table index only.

MenuGetFunctionID — Gets the integer for the function by table index or Function Code.

MenuGetFunctionProperties — Returns an array of properties for a specified function.

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-10-21

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/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.