GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Nine — Dialog Functions (continued)

ComboBoxLoadFolder Function

Overview

The ComboBoxLoadFolder function loads filenames, folders, and drives into a list box.

Syntax/Parameters

Syntax

int = ComboBoxLoadFolder ( int id, string target, [dword flags] );

Parameters

id

An int containing the control ID of a combo box.

target

A string that specifies an absolute path, relative path, or file name. If the string specifies a file name or folder that has attributes specified by the flags parameter, the file or folder name is added to the list. If the file or folder name contains wildcard characters (? or *), all names that match the wildcard expression and have the attributes specified by the flags parameter are added to the list box portion of the combo box.

flags

An optional int that specifies additional attributes to be included or excluded during the load process. The default is to load with files with read/write attributes. Use the DDL_EXCLUSIVE bit to indicate that no default flags are to be used. The following bitwise flags are permitted:

	Value		Bit		Meaning
	DDL_ARCHIVE		0x00000020		Includes files with the archived flag set.
	DDL_DIRECTORY		0x00000010		Includes subdirectories, which are enclosed in square brackets ([   ]).
	DDL_DRIVES		0x00004000		All mapped drives are added to the list. Drives are listed in the form [-x-], where x is the drive letter.
	DDL_EXCLUSIVE		0x00008000		Includes only files with the specified attributes. By default, read/write files are listed even if DDL_READWRITE is not specified.
	DDL_HIDDEN		0x00000002		Includes hidden files.
	DDL_READONLY		0x00000001		Includes read-only files.
	DDL_READWRITE		0x00000000		Includes read/write files with no additional attributes. This is the default.
	DDL_SYSTEM		0x00000004		Includes system files.

 

Return Value

Returns an int as the index of the last item added to the combo box section or a formatted error code on failure. Common error codes are as follows: ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.

Remarks

The function adds the names of directories and files that match a specified target string and set of file attribute flags.

Related Functions

ComboBoxAddArray — Adds an array of items to the list box portion to the end or in sorted position.

ComboBoxAddItem — Adds item to combo box list box section. Item may be a string or an integer value.

ComboBoxInsertItem — Inserts an item in the list box section at a specified position as a string or integer.

ComboBoxLoadList — Loads the list box portion with items from a string as line, csv or space delimited.

ComboBoxReset — Resets combo box’s content.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.