ssCore.FileSys.fileList

Returns a list of files in a specified directory.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

path - A fully qualified directory path. This parameter supports monikers.

delimiter - [Optional] - Character to be used as a delimiter between directories in the results. Default value is |.

showHidden - [Optional] - A flag that indicates whether to return hidden files or not Valid values include: true,false. Default value is false.


Output Parameters:

result - List of files.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.FileSys.fileList( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.FileSys.fileList( paramsObject );


Notes:

The delimiter need not be a single character, but you should be careful to use only characters that cannot appear in file or directory names. Other good choices for delimiter characters includes "?" and newline ("\n").

                

Examples:

var return_obj = ssCore.FileSys.fileList({path:"startdir://"});

ssDebug.trace(return_obj.result);