Command: DirLstWrite

Display all  Hide all

Generates a list with filenames. The command does not support Unicode filenames. Use the DirListGet command instead.

Input Parameters

DirSearchPath	Specifies on which drive and in which folder DIAdem searches for the files. String variable
DirSearchName	Specifies the name of the file that DIAdem searches for in the specified path. String variable
DirSortType	Specifies how DIAdem sorts the list it finds. Enumeration variable Enumeration variable with the following selection terms Script Term Interface Term, Explanation "filename" Filename "extension" Filename Extension "filesize" File size "Date/Time" Date/Time
FileLstName	Specifies the path and the name of the ASCII file that DIAdem writes the filenames into. String variable
FileLstMode	Specifies whether DIAdem overwrites the contents of the ASCII file or whether DIAdem appends new rows to the ASCII file. Byte variable 0 <= FileLstMode <= 1 The FileLstMode variable can accept the following values: 0 Create new file 1 Append to file
[FileLstFilter]	Specifies the information that DIAdem saves. The default value of the FileLstFilter variable is onlyFilenames. Enumeration variable Enumeration variable with the following selection terms Script Term Interface Term, Explanation "onlyFilenames" Only filenames "onlyDirectorynames" Only path names "Filenames" Filenames and filename extensions "FullFilenames" Complete filenames "FullFilenamesRecursive" Recursive after complete filenames "DirectorynamesRecursive" Recursive after path names

Return Parameters

Note  Sorting with the DirSortType variable is case sensitive. Usually sorts in ascending order. For example, if DIAdem finds the filenames FILE.txt and company.txt, the program enters the filename in uppercase before the filename in lowercase. If you sort by date/time, DIAdem first finds the newest files.

Note  You can use the ASCII file created with the DirLstWrite command as a list file for serial evaluation.

Examples

The following example searches for all the files from the NAVIGATOR user folder, that have names starting with Demo. DIAdem sorts the list according to filename, and returns the complete path, the filename, and the filename extensions.

Dim vFoundFiles, iCount, strAll
vFoundFiles =  DirLstWrite(DataReadPath, "Demo*.*", "filename", , 0, "FullFilenames")
If IsArray(vFoundFiles) Then
  For iCount = 0 to Ubound(vFoundFiles)
    strAll =  strAll & vFoundFiles(iCount) & VBCrLf
  Next
  MsgBoxDisp strAll
End If

vFoundFiles =  dd.DirLstWrite(dd.DataReadPath, "Demo*.*", "dd.filename","" , 0, "FullFilenames") 
if IsArray(vFoundFiles): 
    for iCount in range( 0, len(vFoundFiles) + 1): 
        strAll =  strAll + vFoundFiles(iCount) + "\r\n" 
    dd.MsgBoxDisp strAll 

Related Topics

Command: DataFileDelete | Command: DataFileLstGet | Command: DataFileMove | Command: DataFileRename | Command: FileAttrClear | Command: FileAttrSet | Command: FileClose | Command: FileCloseAll | Command: FileCopy | Command: FileDateSet | Command: FileDelete | Command: FileMove | Command: FileOpen | Command: FileRename | Function: DataFileSize