  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Thirteen — Collaboration Functions (continued)
Overview
The GetTaskProperties function will return task elements from a specified task by ID or location and index.
Syntax/Parameters
Syntax
string[] = GetTaskProperties ( string id | [int location, int index] );
Parameters
id
An optional string specifying the ID for the task to retrieve properties. If the id is specified, then the location and index cannot be specified.
location
An optional int that specifies the location to retrieve the task. If specified, the index must also be specified. See Locations Codes at start of the Collaboration section.
index
An optional int that along with the location specifies the zero-based position within the data store and location of the task.
Return Value
A string array of task data elements. If an error occurs or there are no tasks, the array will be empty. Use the GetLastError function to determine if an error occurred and the nature of the error. If there are no tasks for the requested location, the last error will be ERROR_EOD.
Remarks
Task IDs can be retrieved using the GetTaskIDs function and provide an easy way to reference a specific task. On the other hand, the location and index can be used to enumerate specific tasks.
See Section 13.3 Task Functions for key names within the array.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
| 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.