FileSystem.DirectoryList(String, Variable, Variable) Method

Top

Description

Lists the names of files and folders contained within the specified path.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

FileSystem.DirectoryList(	String path,
	Variable recursive,
	Variable contentToList)

Arguments

path
Description:	The path to the directory whose contents are to be listed.

recursive

Description:

A flag which determines if subfolders will have their contents listed, recursively.

Valid Values:

Value	Label
0	false
1	true

contentToList

Description:

Determines which type of content is to be listed.

Valid Values:

Value	Label
0	All
1	Files only
2	Directories only

Return Value

Type:

Array of string

Returns a StringArray populated with the names of files an directories contained within the specified directory.

Syntax

myStringArray1 = FileSystem.DirectoryList(myString1, myVariable1, myVariable2);