File Library

• Abstruct
• Index
• Structs
• Variables
• Functions
• Implementation Code

Abstract

The VCSSL File library is a standard library that provides various file-related functions, such as obtaining file paths and getting lists of file names in directories.
However, this library does not handle file I/O. For file I/O, use the System library or the file.TextFile library.

Index

const int ABSOLUTE

The option value representing an absolute path.

const int RELATIVE

The option value representing a relative path.

const int PARENT

The option value representing a parent directory.

const int HOME

The option value representing the user's home directory.

const int ROOT

The option value representing the root directory.

const int TMP

The option value representing the temporary-file directory provided by the computer.

const int UNORDERED

The option value representing an unordered file order.

const int LEXICAL

The option value representing a lexically sorted file order.

bool isDirectory( string pathOrName )

Determines whether the specified file is a directory.

void makeDirectory( string pathOrName )

Creates a new directory.

string[ ] listDirectory( string pathOrName )

Returns the list of file names directly under the specified directory. The order of file names is not specifically sorted and depends on the environment and implementation.

string[ ] listDirectory( string pathOrName, bool sortByIgnoreCase, int sortOption )

Returns the list of file names directly under the specified directory. A sorting option for file names can be specified.

void makeFile( string pathOrName )

Creates a new file.

string getFileName( string path )

Gets the file-name part from a file path.

void removeFile( string pathOrName )

Deletes a file.If the target is a directory, it cannot be deleted unless it is empty, so its contents must be removed first.

void moveFile( string pathOrName, string newName )

Moves a file or changes its file name.If both arguments are only file names, or if both are file paths in the same directory, the operation becomes a file rename.If the arguments are file paths in different directories, the operation becomes a file move.Moving across drives may not be supported depending on the environment.

void renameFile( string pathOrName, string newName )

Renames a file.If a path is specified instead of just a file name as the destination,the file is moved. However, moving across drives may not be supported depending on the environment.

Note: The use of this API is not recommended. Its behavior depends on the implementation and version. In VCSSL 3.3 and later, use moveFile instead.If you must use this API and want to avoid such dependencies, specify the destination file path newPath as an absolute path. The behavior when specifying only a relative path or file name depends on the implementation and version.In the current standard VCSSL runtime, if a file name or relative path is specified for newPath, it is interpreted relative to the location of the executed program. However, in older versions such as VCSSL 3.2 and earlier, it may instead be interpreted relative to the implementation location.By specifying an absolute path, you can avoid version-dependent behavior.For example, if you write renameFile("Test1.txt", "Test2.txt");, the current standard VCSSL runtime renames Test1.txt to Test2.txt in the same directory. However, in older versions, "Test2.txt" may be interpreted as a path relative to the implementation, so the file may be moved to the implementation directory where VCSSL.jar exists. Even in older versions, if you want to rename a file within the same directory, write something like renameFile("hoge1.txt", getFilePath("hoge2.txt", getFilePath(".")) );.

void copyFile( string inputPath, string outputPath )

Copies a file.

string getFilePath( string pathOrName )

Gets and returns the absolute path from a file name or relative path.

string getFilePath( string pathOrName, int type )

Gets and returns an absolute path, relative path, or parent-directory path from a file name or path.

string getFilePath( string pathOrName, string directory )

Converts and returns a file name or relative path, interpreted from the specified base directory, as an absolute path.

string getFilePath( string pathOrName, string directory, int type )

Converts a file name or relative path interpreted from the specified base directory into an absolute path, a relative path based on the executed program, or a parent-directory path based on the executed program.

string[ ] getFilePath( int target )

Gets the paths of special locations in the runtime environment or operating system.

string getMainDirectory()

Returns the path of the directory containing the executed program.It can now be obtained by getFilePath("."). This function is supported for compatibility.

string getHomeDirectory()

Returns the path of the home directory.It can now be obtained by getFilePath( HOME ). This function is supported for compatibility.

string[ ] getRootDirectory()

Returns the path of the root directory.It can now be obtained by getFilePath( ROOT ). This function is supported for compatibility.

string getParentDirectory( string pathOrName )

Returns the path of the parent directory.It can now be obtained by getFilePath( pathOrName, PARENT ). This function is supported for compatibility.

string getFileRelativePath( string pathOrName, string directory )

Converts and returns a relative path based on the specified directory into a relative path based on the executed program.It can now be obtained by getFilePath( pathOrName, directory, RELATIVE ). This function is supported for compatibility.

string[ ] getFileList( string pathOrName )

Gets the list of file names directly under the specified directory.It can now be obtained by listDirectory( pathOrName ). This function is supported for compatibility.In this function, the ordering of file names depends on the environment and operating system. Processing that assumes a specific order is not recommended. The newer listDirectory( pathOrName ) can accept sorting options.

Structs

- None -

Variables

Functions