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

Table of Contents	< < Previous	Next >>

 

Chapter Seventeen — Application Integration Functions (continued)

MenuGetHook Function

Overview

The MenuGetHook function retrieves a requested hook in the form of an array of parameters.

Syntax/Parameters

Syntax

string[] = MenuGetHook ( int id | string code );

Parameters

id

An int that specifies the function ID as returned to the script from various menu functions. This id code can be dynamic, thus programmers should not use fixed values for functions. When id is supplied, code cannot be used.

code

A string containing the specific code for a function (for example, “EDGAR_SUBMIT_TEST”). When code is supplied, id cannot be used.

Return Value

Returns a string array as a list containing the parameters or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The key names within the returned array are as follows:

	Name		Description
	FunctionID		Function ID as a string (use DecimalToInteger to convert).
	FunctionCode		Function Code.
	HookFlags		Hook flags as hex. Bits not published.
	Status		Status: ‘OK’ or ‘Error’.
	ScriptName		Name of script serving hook.
	FunctionName		Name of function serving hook.
	FunctionMapIndex		Map position of index.
	ScriptTimeStamp		The modified time of the script. Used to reload the script on changes.

 

Related Functions

MenuAddFunction — Adds a function to the application function list.

MenuDeleteHook — Deletes a hook by Function ID or Code.

MenuEnumerateHooks — Enumerates all menu hooks.

MenuIsHooked — Checks for a Menu Hook for ID.

MenuSetHook — Sets a hook for a specific menu item ID.

Platform Support

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

Legato IDE

 

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.