Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter SixFile Functions (continued)

CreateFolders Function

Overview

The CreateFolders function recursively creates folders for an entire limb of a directory tree structure.

Syntax/Parameters

Syntax

int = CreateFolders ( string name );

Parameters

name

A string containing a fully qualified path. The last path connector (slash) following the folder name is not required. This parameter supports UTF encoding for filenames with Unicode characters.

Return Value

Returns an int as ERROR_NONE on success or a formatted error code on failure. Use the GetLastError function to retrieve error information.

Remarks

The CreateFolders function recursively creates a series of folders in a path. This means that any folder that does not already exist in the name parameter’s directory tree limb will be created. If any folder within the path already exists, the CreateFolder function does not return an error. This is a deliberate feature to allow scripts to not be concerned about checking to see if a folder already exists before creating it.

The script must have access permissions for each level along the entire path to use this function.

Related Functions

Platform Support

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

Legato IDE, Legato Basic