  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
AttachApplicationProgress Function
Overview
The AttachApplicationProgress function checks if the application has a progress window open and then borrows the application class for the script.
Syntax/Parameters
Syntax
int = AttachApplicationProgress ( );
Parameters
(none)
Return Value
Returns an int value as ERROR_NONE or a formatted error code on failure. The sub codes are as follows:
1 — The application does not have a progress class open.
2 — The script already has a program class open.
Remarks
When a script is called as a hook or from another running process, it can be desirable to use the existing program window. The script must comply with the caller’s structure. For example, if the caller has set phases, the script should obey the phase structure. Generally, it is advisable to update the progress and use the second status line.
The term application class is used rather than window since attaching does not require the progress window to be visible, only that the class has been instantiated and setup.
ProgressClose will not close the progress, but rather releases the script’s attachment to the application progress window.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| 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.