Skip to content

TSTool / Command / ListFiles

Overview

The ListFiles command lists files and folders in a starting folder and saves the list to a table. The table can then be used to drive processes, such as looping with For command and working with a template.

Parameters are available to control the listing:

  • List files and/or folders.
  • Process a single folder or also process sub-folders.
  • Provide names to include and exclude.

The resulting table will include the following columns:

ListFiles Output Table

Column Description
Name Name of the file without leading path (prior to TSTool 14.8.0 this column is called FileName).
RelativePath File or folder path relative to the command file working directory.
AbsolutePath File or folder absolute path.
ParentFolder Parent folder absolute path path.
Type
  • File - for files
  • Folder - for folders
Size File size in bytes, blank for folders.
Owner The file or folder owner.
LastModified The last modification time for the file or folder in local time.

Command Editor

The command is available in the following TSTool menu:

  • Commands / General - File Handling

The following dialog is used to edit the command and illustrates the command syntax.

ListFiles command editor

ListFiles Command Editor Showing Conditions Test (see full-size image)

Command Syntax

The command syntax is as follows:

ListFiles(Parameter="Value",...)

Command Parameters

Parameter                 Description Default                
Folder
required		 The starting folder. None - must be specified.
ListScope The scope for the listing:
  • All - Folder and its sub-folders
  • Folder - only list the contents immediately in Folder
 Folder
ListFiles Whether files should be listed (True) or not (False). True
ListFolders Whether folders should be listed (True) or not (False). False
IncludeNames A pattern indicating names to include. The pattern is only checked for the name, not the leading path. Use * in the name for a wildcard. All names will be included.
ExcludeNames A pattern indicating names to exclude. The pattern is only checked for the name, not the leading path. Use * in the name for a wildcard. No names will be excluded.
TableID
required		 The identifier for the output table. If the table does not exist, it will be created. See also Append. None - must be specified.
Append Indicate whether list output should be appended to the table (True). This allows multiple ListFiles commands to be used to create a larger list. False - the table will contain only the current output list.

Examples

See the automated tests.

Troubleshooting

See the main TSTool Troubleshooting documentation.

See Also