Salesforce

ClientFileListGet (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

ClientFileListGet (Magic xpa 4.x)

Returns a list of the file names in a directory based on a set of file-name filters.

Syntax:

ClientFileListGet(directory name, filter list, sub dir search)

Parameters:

directory name – A string representing a directory.
The string can contain logical names.

filter list – A string representing a list of file filters, including wildcard characters separated by the ‘|’ character. For example: '*.xml|*.xsd'. If the value of this argument is an empty string, all files in the directory will be listed.

sub dir search – A boolean parameter. True means that the directory and all subdirectories are searched. False means that only the specified directory is searched.

Returns:

A vector that contains Alpha strings. Each cell has a string that is the file's name and relative path, for example: 'dir1\po.xml'. If no files are found, a Null is returned.

Example:

ClientFileListGet('c:\temp','*.xml|*.xsd','TRUE'LOG) returns a vector containing alpha strings. Each entry in the vector contains a file name that is found in the 'C:\temp\directory' and its subdirectories, for example: 'dir1\po.xml'.

Note:

This is a client-side function that is only available for Rich Client tasks.

Exceptions:

This function is not supported in Web Client tasks.

See also:

To use the server-side version of this function in Rich Client tasks, see FileListGet.

The Rich Client Samples project (program REL18)

Reference
Attachment 
Attachment