Skip to main content

LogicalFileList

STD.File.LogicalFileList( [ pattern ] [, includenormal ] [, includesuper ] [, unknownszero ] [, foreigndali ] )

patternOptional. A null-terminated string containing the mask of the files to list. If omitted,the default is '*' (all files).
includenormalOptional. A boolean flag indicating whether to include "normal" files. If omitted, the default is TRUE.
includesuperOptional. A boolean flag indicating whether to include SuperFiles. If omitted, the default is FALSE.
unknownszeroOptional. A boolean flag indicating to set file sizes that are unknown to zero (0) instead of minus-one (-1). If omitted, the default is FALSE.
foreigndaliOptional. The IP address of the foreign dali used to resolve the file. If blank then the file is resolved locally. If omitted, the default is blank.
Return:LogicalFileList returns returns a dataset in the following format:
EXPORT FsLogicalFileNameRecord := RECORD
  STRING name;
END;

EXPORT FsLogicalFileInfoRecord := RECORD(FsLogicalFileNameRecord)
  BOOLEAN superfile;
  UNSIGNED8 size;
  UNSIGNED8 rowcount;
  STRING19 modified;
  STRING owner;
  STRING cluster;
END;

The LogicalFileList function returns a list of the logical files in the environment files as a dataset in the format listed above.

Example:

OUTPUT(STD.File.LogicalFileList());
  //returns all normal files
    
OUTPUT(STD.File.LogicalFileList(,FALSE,TRUE));
  //returns all SuperFiles