File Management functions

Owned by Systems Next Limit (Unlicensed)
Last updated: 21 May, 2021 by Next Limit
2 min read

int getNumberOfFilesInFolder( string path, string filter )

Returns the number of files in the given folder that match the filter.

Parameters

String path: Folder to search files / String filter: File filter (“.” is allowed).

Returned Value

INT: number of files in the folder that mach the filter.

Example 1
some code here;
var folder;

stringlist getFilesInFolder( string path, string filter )

Returns a list of files in the given folder that match the filter.

Parameters

String path: Folder to search files / String filter: File filter (“.” is allowed).

Returned Value

LIST: list of files in the folder that match the filter.

Example 1
some code here;
var folder;

 
 

• Function: string getFileFolder( string file );
• Description: Returns the absolute path of the folder that contains the given file.
• Parameters: String file: File path
• Returned Value: String path of the folder that contains the given file.

• Function: string getFileName( string file );
• Description: Returns the file name of this path. The name does not include the extension.
• Parameters: String file: File path
• Returned Value: String: name of the file.

• Function: string getFileNameAndExtension( string file );
• Description: Returns the file name of this path. The name includes the extension.
• Parameters: String file: File path
• Returned Value: String: name of the file.

• Function: INT getNumberOfFilesInBranch( string path, string filter );
• Description: Returns the number of files in the folder path and all the subfolders that match the given filter. This function searches recursively until the branch is completed.
• Parameters: String path: Path of the folder to search / String filter: Filter to match
• Returned Value: INT: Number of files that match the condition.

• Function: stringlist getFilesInBranch( string path, string filter );
• Description: Returns a list of files in the folder path and all its subfolders that match the given filter. This function searches recursively until the branch is completed.
• Parameters: String path: Path of the folder to search / String filter: Filter to match
• Returned Value: LIST: List of files that match the condition.

• Function: bool copyFile( string origin, string target );
• Description: Copies a file from origin to target.
• Parameters: String origin: Path of the file to copy / String target: Path of the target file
• Returned Value: Bool: returns True if the copy was successful, False if it was unsuccessful.

• Function: bool removeFile( string path );
• Description: Removes the specified file.
• Parameters: String path: Path of the file to remove
• Returned Value: Bool: returns True if the file was removed successfully, False if not.

• Function: bool renameFile( string path, string name );
• Description: Renames the specified file.
• Parameters: String path: Path of the file to rename. String name: New name of the file
• Returned Value: Bool: returns True if the file was renamed successfully, False if not.

• Function: bool createAbsoluteFolder( string path );
• Description: Creates a folder.
• Parameters: String path: Path of the folder to create
• Returned Value: Bool: returns True if the folder was created successfully, False if not.

• Function: bool createRelativeFolder( string parentFolder, string folderName );
• Description: Creates a folder given a relative path.
• Parameters: String parentFolder: Path of the parent folder where the folder will be created. String folderName: Name of the folder
• Returned Value: Bool: returns True if the folder was created successfully, False if not.