Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

BrowseOpenFiles Function

Overview

The BrowseOpenFiles function allows the selection of multiple files presumably for an open or other operation.

Syntax/Parameters

Syntax

string[] = BrowseOpenFiles ( string title, [string filter], [string path] );

Parameters

Title

A string that becomes the dialog’s caption. Note that for browse dialogs, the dialog caption is used to store sticky path information in applications settings file. Depending on the application settings, the path may be remembered and used assuming no incoming path is provided to the function.

filter

A string that specifies an optional filter list. If a filter list is not provided, the default of “All Files (*.*)” will be added to the filter list. See Filters at the start of Section 9.2 Common Dialogs for filter string formatting information.

path

Specifies an optional string to direct the opening path. If no path is provided, the last path selected for the specified title is used. Barring that, the application’s current working directory is used.

Return Value

Returns a string array containing a series of paths and filenames or an empty string if error. The first array entry will be empty on error. Use GetLastError to determine the error. The most common error is ERROR_CANCEL for the user pressing the “Cancel” button. Each return string will be a qualified and valid filename and path.

The result is UTF encoded to allow the representation of Unicode data. Use the UTFToUnicode function and related functions to convert to Unicode.

Remarks

The return of filename does not indicate that the script has permissions to access the file.

The function will use the Windows Common Open file dialog based on Windows Explorer or the application’s browse class depending on the application settings.

Related Functions

Platform Support

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

Legato IDE, Legato Basic