  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Four — Flow Control (continued)
Overview
The GetScriptProperties function returns properties for a running or completed script by handle.
Syntax/Parameters
Syntax
string [] = GetScriptProperties ( [handle hObject] );
Parameters
hHandle
An optional handle to a background thread or to a script. If omitted, the properties for the calling script are returned.
Return Value
Returns a string array with the script properties or an empty array on error. Use the GetLastError function to retrieve a formatted error code.
Remarks
The array will contain the following key names:
| Key Name | Description | ||
| Type | The type of entry: “Active” or “Completed”. | ||
| ScriptHandle | The handle to the script in the form of a hex number: 0x00000000. | ||
| ThreadHandle | The thread handle to the script in the form of a hex number: 0x00000000. This value will be zero if the script is running (suspended) in the primary program thread. | ||
| ScriptName | The given name of the script. This value can be set by SetScriptName function. | ||
| ScriptDescription | The description of the script. This value can be set by SetScriptDescription function. | ||
| ScriptParent | Calling parent for the script. | ||
| StartTime | The date and time the script started in ISO-8601. | ||
| EndTime | The date and time the script ended in ISO-8601. If the script has not ended, then this field will not be present. | ||
| ResultCode | If the script has completed, the result code from the script in the form of a hex string. If the script was aborted due to a runtime error, this will contain the last error code. | ||
| ErrorLog | If an error log is available this value will be ‘1’. | ||
| DefaultLog | If the default output log is available this value will be ‘1’. |
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.