Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter SixFile Functions (continued)

SetWorkingFolder Function

Overview

The SetWorkingFolder function sets the Windows default folder for a process or program (host program).

Syntax/Parameters

Syntax

int = SetWorkingFolder ( string path );

Parameters

path

A string containing a valid path.

 Return Value

An int as ERROR_NONE (0) or a formatted error code.

Remarks

The Windows default folder (current working directory) as associated with the current process. It may be the directory from which the application was launched or it can be set using this 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 GetWorkingFolder function in other threads and produces potentially undesirable behavior.

The host application does not use the working directory.

The SetWorkingFolder and SetWorkingDirectory functions are exactly the same. They are provided with different names 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