Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ThirteenCollaboration Functions (continued)

GetTaskIDs Function

Overview

The GetTaskIDs function will return task ID strings from one specific location or all locations from the collaboration store.

Syntax/Parameters

Syntax

string[] = GetTaskIDs ( [int location] );

Parameters

locations

An optional int that specifies the location to get the task IDs. If omitted (or zero), all task IDs are enumerated.

Return Value

A string array of task IDs. 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

When retrieving all task IDs, the ID prefix can be used to determine the location of the task.

Locations codes are as follows:

  Definition   Ordinal   Description
  CM_LOCATION_UNKNOWN   0   Location Not Set
  CM_LOCATION_ALL   0   Reference All Locations
  CM_LOCATION_GLOBAL   1   Global (specified by enterprise preferences)
  CM_LOCATION_USER   2   User
  CM_LOCATION_PROJECT   3   Project File (for open project)
  CM_LOCATION_PROJECT_ENTRY   4   Project Entry (for open project and entry)
  CM_LOCATION_TEMPLATE   5   Template

 

Related Functions

Platform Support

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