  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Seventeen — Application Integration Functions (continued)
AddFrameInitializeFunction Function
Overview
The AddFrameInitializeFunction function adds a script to the frame (desktop) initialization chain with an optional function and parameters.
Syntax/Parameters
Syntax
int = AddFrameInitializeFunction ( [word order], string name,
[string
function], [parameters ...] );
Parameters
order
An optional word that specifies the priority order of the script. This allows scripts/calls to be ordered in the manner in which they are executed. If omitted, the script is set to the bottom priority.
name
A string containing the name of the script to run. If name is empty, the script calling the AddFrameInitializeFunction is used. If a root path is not provided, the calling script’s path is used as a basis for the filename.
function
An optional string containing the name of the function to run. If omitted or empty, the default entry point is located and run.
parameters
Zero or more optional parameters to pass to the script. Variables cannot be passed by reference. When parameters are employed, the function parameter must be provided. However, it can be a simple "" empty string. Handles cannot be passed.
Return Value
Returns an int as ERROR_NONE on success or a formatted error code on failure.
Remarks
This function can only be called during the non-GUI initialization phase of the application start up. It can be called during the script extension load. If called when the frame/desktop is open, it will fail.
The script filename is checked for availability as part of the process of adding the script to the queue. Any issues accessing the file will be immediately returned as an error. The validity of the script program, both compile and runtime errors, are not checked.
Each script added to the queue for execution is run as a separate instance. The script adding the call to the queue can be the same script but will be run anew when it is eventually executed. This includes adding multiple functions to the execution chain from the same script file. Each will be run in succession as a new instance. Once executed, the instance is discarded.
Frame initialization occurs in the following order:
— Scripts added with AddFrameInitializeFunction
— Command Line Actions (second processing)
— News RSS Feed Run
— Crash File Recovery Process
— Dashboard Processing
— Error Report Upload Request
— User Account Control Edit
— Application “First Run” Actions
A maximum of 16 scripts can be added to the execution queue.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE
| Table of Contents | < < Previous | Next >> |
© 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.