Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

GetWorkingDirectory Function

Overview

The GetWorkingDirectory function retrieves the Windows default folder for a process or program (host application).

Syntax/Parameters

Syntax

string = GetWorkingDirectory ( );

Parameters

(none)

 

 Return Value

Returns a string containing the current working directory or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The Windows default folder, or current working directory, is associated with the current process. It may be the directory from which the application was launched or it can be set using the SetWorkingDirectory function. The string returned contains a disk designator or UNC share name followed by the path.

Multi-threaded scripts should not rely on the current working directory as it can be changed during the execution of one thread, which interferes with the usage of the GetWorkingDirectory function in other threads and produces potentially undesirable behavior.

The GetWorkingDirecting and GetWorkingFolder functions are exactly the same. They are provided with different name since the term folder is used throughout Legato and Windows but “working directory” is commonly used in the command prompt and in other applications.

Related Functions

Platform Support

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

Legato IDE, Legato Basic