File ライブラリ


概要 - Abstract

VCSSL File ライブラリ は、ファイルパスの取得や、ディレクトリ内のファイル名リスト取得など、ファイルに関する各種機能を提供する標準ライブラリです。
ただし、このライブラリではファイルI/Oは扱いません。ファイルI/Oについては、System ライブラリや file.TextFile ライブラリを使用してください。


目次 - Index

const int ABSOLUTE
絶対パスを意味する設定値です。
const int RELATIVE
相対パスを意味する設定値です。
const int PARENT
親階層を意味する設定値です。
const int HOME
ホームディレクトリを意味する設定値です。
const int ROOT
ルートディレクトリを意味する設定値です。
const int UNORDERED
特に整列されていないファイル順序を意味する設定値です。
const int LEXICAL
辞書順に整列されたファイル順序を意味する設定値です。
bool isDirectory( string pathOrName )
ファイルがディレクトリであるかどうかを判定します。
void makeDirectory( string pathOrName )
ディレクトリを新規作成します。
string[ ] listDirectory( string pathOrName )
指定ディレクトリ直下にあるファイル名の一覧を返します。ファイル名の順序は特に整列されず、環境や処理系に依存します。
string[ ] listDirectory( string pathOrName, bool sortByIgnoreCase, int sortOption )
指定ディレクトリ直下にあるファイル名の一覧を返します。ファイル名の整列オプションを指定できます。
void makeFile( string pathOrName )
ファイルを新規作成します。
string getFileName( string path )
ファイルパスから、ファイル名の部分を取得します。
void removeFile( string pathOrName )
ファイルを削除します。対象がディレクトリの場合、中身が空でなければ削除できないため、先に中身を削除する必要があります。
void moveFile( string pathOrName, string newName )
ファイルの移動や、ファイル名の変更を行います。引数が、共にファイル名のみの場合や、共に同じディレクトリ内のファイルパスである場合には、処理内容はファイル名の変更になります。引数が、互いに異なるディレクトリ内のファイルパスである場合には、処理内容はファイルの移動になります。ファイルは移動されます。ドライブをまたぐ移動はできない場合があります。
void renameFile( string pathOrName, string newName )
ファイル名を変更します。変更先にファイル名ではなくパスを指定した場合、ファイルは移動されます。ただし環境によっては、ドライブをまたぐ移動はできない場合があります。
※ このAPIの使用は推奨されません。このAPIの動作は処理系やバージョンに依存します。VCSSL 3.3 以降では、代わりに同機能の moveFile を使用してください。やむを得ずこの API を使用する必要があり、依存性を回避したい場合には、変更後のファイルパス newPath を絶対パスで指定してください。相対パスやファイル名のみを指定した場合の挙動は、処理系やバージョンに依存します。現在の標準VCSSLランタイムでは、newPath にファイル名や相対パスを指定した場合、実行プログラムの場所を基準とするものと解釈されますが、VCSSL 3.2 以前の古いバージョンなどでは、処理系の場所を基準として解釈される場合があります。絶対パスを指定すればバージョンへの依存性を回避できます。 例えば、renameFile("Test1.txt", "Test2.txt"); と記述した場合、現在の標準VCSSLランタイムでは、同じディレクトリ内で Test1.txt のファイルが Test2.txt に名称変更されます。しかし古いバージョンでは、"Test2.txt" は処理系からみた相対パスと解釈されるため、ファイルは処理系のディレクトリ( VCSSL.jar のある場所 )に移動されます。古いバージョンにおいても、同じディレクトリ内における名称変更を行いたい場合は、 renameFile("hoge1.txt", getFilePath("hoge2.txt", getFilePath(".")) ); などと記述します。
void copyFile( string inputPath, string outputPath )
ファイルをコピーします。
string getFilePath( string pathOrName )
ファイル名または相対パスから、絶対パスを取得して返します。
string getFilePath( string pathOrName, int type )
ファイル名またはパスから、絶対パスまたは相対パス、もしくは親階層パスを取得して返します。
string getFilePath( string pathOrName, string directory )
指定された基準ディレクトリから見たファイル名または相対パスを、絶対パスに変換取得して返します。
string getFilePath( string pathOrName, string directory, int type )
指定された基準ディレクトリから見たファイル名または相対パスを、絶対パスまたは(実行プログラム基準の)相対パス、もしくは(実行プログラム基準の)親階層パスに変換して返します。
string[ ] getFilePath( int target )
実行環境やオペレーティングシステムにおける特別な場所のパスを取得します。
string getMainDirectory()
実行プログラムがあるディレクトリのパスを返します。現在は getFilePath(".") で取得できます。この関数は互換目的でサポートされています。
string getHomeDirectory()
ホームディレクトリのパスを返します。現在は getFilePath( HOME ) で取得できます。この関数は互換目的でサポートされています。
string[ ] getRootDirectory()
ルートディレクトリのパスを返します。現在は getFilePath( ROOT ) で取得できます。この関数は互換目的でサポートされています。
string getParentDirectory( string pathOrName )
親階層のパスを返します。現在は getFilePath( pathOrName, PARENT ) で取得できます。この関数は互換目的でサポートされています。
string getFileRelativePath( string pathOrName, string directory )
指定ディレクトリから見た相対パスを、(実行プログラムから見た)相対パスに変換して返します。現在は getFilePath( pathOrName, directory, RELARIVE ) で取得できます。この関数は互換目的でサポートされています。
string[ ] getFileList( string pathOrName )
指定ディレクトリ直下のファイル名一覧を取得します。現在は listFile( pathOrName ) で取得できます。この関数は互換目的でサポートされています。この関数では、ファイル名の整列順序は環境やオペレーティングシステムに依存します。特定の順序である事を前提とした処理は推奨されません。新しい listFile( pathOrName ) は整列オプションを指定できます。

構造体 - Structs

- なし - None -


変数 - Variables

定義
- Signature
const int ABSOLUTE
詳細
- Details
絶対パスを意味する設定値です。
定義
- Signature
const int RELATIVE
詳細
- Details
相対パスを意味する設定値です。
定義
- Signature
const int PARENT
詳細
- Details
親階層を意味する設定値です。
定義
- Signature
const int HOME
詳細
- Details
ホームディレクトリを意味する設定値です。
定義
- Signature
const int ROOT
詳細
- Details
ルートディレクトリを意味する設定値です。
定義
- Signature
const int UNORDERED
詳細
- Details
特に整列されていないファイル順序を意味する設定値です。
定義
- Signature
const int LEXICAL
詳細
- Details
辞書順に整列されたファイル順序を意味する設定値です。

関数 - Functions

定義
- Signature
bool isDirectory( string pathOrName )
詳細
- Details
ファイルがディレクトリであるかどうかを判定します。
引数
- Arguments
pathOrName : 対象ファイルの名称またはパス。
戻り値
- Return
ディレクトリであれば true 、そうでなければ false。
定義
- Signature
void makeDirectory( string pathOrName )
詳細
- Details
ディレクトリを新規作成します。
引数
- Arguments
pathOrName : 作成するディレクトリの名称またはパス。
定義
- Signature
string[ ] listDirectory( string pathOrName )
詳細
- Details
指定ディレクトリ直下にあるファイル名の一覧を返します。ファイル名の順序は特に整列されず、環境や処理系に依存します。
引数
- Arguments
pathOrName : 対象ディレクトリの名称またはパス。
戻り値
- Return
ディレクトリ直下にあるファイル名の一覧。
定義
- Signature
string[ ] listDirectory( string pathOrName, bool sortByIgnoreCase, int sortOption )
詳細
- Details
指定ディレクトリ直下にあるファイル名の一覧を返します。ファイル名の整列オプションを指定できます。
引数
- Arguments
pathOrName : 対象ディレクトリの名称またはパス。
sortByIgnoreCase : 整列時に大文字/小文字を区別するかどうか。true なら無視されます。
sortOption : 整列オプション。UNORDERED または LEXICAL を指定します。
戻り値
- Return
ディレクトリ直下にあるファイル名の一覧。
定義
- Signature
void makeFile( string pathOrName )
詳細
- Details
ファイルを新規作成します。
引数
- Arguments
pathOrName : 作成するファイルの名称またはパス。
定義
- Signature
string getFileName( string path )
詳細
- Details
ファイルパスから、ファイル名の部分を取得します。
引数
- Arguments
path : 対象ファイルのパス。
戻り値
- Return
ファイル名
定義
- Signature
void removeFile( string pathOrName )
詳細
- Details
ファイルを削除します。
対象がディレクトリの場合、中身が空でなければ削除できないため、先に中身を削除する必要があります。
引数
- Arguments
path : 対象ファイルの名称またはパス。
定義
- Signature
void moveFile( string pathOrName, string newName )
詳細
- Details
ファイルの移動や、ファイル名の変更を行います。引数が、共にファイル名のみの場合や、共に同じディレクトリ内のファイルパスである場合には、処理内容はファイル名の変更になります。引数が、互いに異なるディレクトリ内のファイルパスである場合には、処理内容はファイルの移動になります。ファイルは移動されます。ドライブをまたぐ移動はできない場合があります。
引数
- Arguments
pathOrName : 対象ファイルの名称またはパス。
newName : 変更後の名称またはパス。
定義
- Signature
void renameFile( string pathOrName, string newName )
詳細
- Details
ファイル名を変更します。変更先にファイル名ではなくパスを指定した場合、ファイルは移動されます。ただし環境によっては、ドライブをまたぐ移動はできない場合があります。
※ このAPIの使用は推奨されません。このAPIの動作は処理系やバージョンに依存します。VCSSL 3.3 以降では、代わりに同機能の moveFile を使用してください。やむを得ずこの API を使用する必要があり、依存性を回避したい場合には、変更後のファイルパス newPath を絶対パスで指定してください。相対パスやファイル名のみを指定した場合の挙動は、処理系やバージョンに依存します。現在の標準VCSSLランタイムでは、newPath にファイル名や相対パスを指定した場合、実行プログラムの場所を基準とするものと解釈されますが、VCSSL 3.2 以前の古いバージョンなどでは、処理系の場所を基準として解釈される場合があります。絶対パスを指定すればバージョンへの依存性を回避できます。 例えば、renameFile("Test1.txt", "Test2.txt"); と記述した場合、現在の標準VCSSLランタイムでは、同じディレクトリ内で Test1.txt のファイルが Test2.txt に名称変更されます。しかし古いバージョンでは、"Test2.txt" は処理系からみた相対パスと解釈されるため、ファイルは処理系のディレクトリ( VCSSL.jar のある場所 )に移動されます。古いバージョンにおいても、同じディレクトリ内における名称変更を行いたい場合は、 renameFile("hoge1.txt", getFilePath("hoge2.txt", getFilePath(".")) ); などと記述します。
引数
- Arguments
pathOrName : 対象ファイルの名称またはパス。
newName : 変更後の名称またはパス。古いバージョンや処理系への依存性を回避するため、絶対パスでの指定が推奨されます。
定義
- Signature
void copyFile( string inputPath, string outputPath )
詳細
- Details
ファイルをコピーします。
引数
- Arguments
pathOrName : コピー元ファイルの名称またはパス。
newName : コピー先ファイルの名称またはパス。
定義
- Signature
string getFilePath( string pathOrName )
詳細
- Details
ファイル名または相対パスから、絶対パスを取得して返します。
引数
- Arguments
pathOrName : 対象ファイルの名称または相対パス。
newName : 対象ファイルの絶対パス。
定義
- Signature
string getFilePath( string pathOrName, int type )
詳細
- Details
ファイル名またはパスから、絶対パスまたは相対パス、もしくは親階層パスを取得して返します。
引数
- Arguments
pathOrName : 対象ファイルの名称またはパス。
type : 取得するパスの種類。ABSOLUTE または RELATIVE もしくは PARENT を指定します。それぞれ絶対パス、相対パス、親階層パスを意味します。
戻り値
- Return
対象ファイルのパス。パスの種類は引数 type で指定します。
定義
- Signature
string getFilePath( string pathOrName, string directory )
詳細
- Details
指定された基準ディレクトリから見たファイル名または相対パスを、絶対パスに変換取得して返します。
引数
- Arguments
pathOrName : 基準ディレクトリから見た、対象ファイルの名称または相対パス。
directory : 相対パスの基準ディレクトリ。実行プログラムを基準とした名称または相対パス、もしくは絶対パスで指定します。
newName : 対象ファイルの絶対パス。
定義
- Signature
string getFilePath( string pathOrName, string directory, int type )
詳細
- Details
指定された基準ディレクトリから見たファイル名または相対パスを、絶対パスまたは(実行プログラム基準の)相対パス、もしくは(実行プログラム基準の)親階層パスに変換して返します。
引数
- Arguments
pathOrName : 対象ファイルの名称またはパス。
directory : 相対パスの基準ディレクトリ。実行プログラムを基準とした名称または相対パス、もしくは絶対パスで指定します。
type : 取得するパスの種類。ABSOLUTE または RELATIVE もしくは PARENT を指定します。それぞれ絶対パス、相対パス、親階層パスを意味します。
戻り値
- Return
対象ファイルのパス。パスの種類は引数 type で指定します。
定義
- Signature
string[ ] getFilePath( int target )
詳細
- Details
実行環境やオペレーティングシステムにおける特別な場所のパスを取得します。
引数
- Arguments
target : 取得する特別な場所の種類。HOME または ROOT を指定します。それぞれルートディレクトリ、ホームディレクトリを意味します。
戻り値
- Return
特別な場所のパス。場所は引数 target で指定します。target に ROOT を取得した場合の挙動はオペレーティングシステムに依存します。単一のルートが存在しないオペレーティングシステムでは、恐らくドライブ名が配列で返されます。
定義
- Signature
string getMainDirectory()
詳細
- Details
実行プログラムがあるディレクトリのパスを返します。
現在は getFilePath(".") で取得できます。この関数は互換目的でサポートされています。
戻り値
- Return
実行プログラムがあるディレクトリのパス。
定義
- Signature
string getHomeDirectory()
詳細
- Details
ホームディレクトリのパスを返します。
現在は getFilePath( HOME ) で取得できます。この関数は互換目的でサポートされています。
戻り値
- Return
ホームディレクトリのパス。
定義
- Signature
string[ ] getRootDirectory()
詳細
- Details
ルートディレクトリのパスを返します。
現在は getFilePath( ROOT ) で取得できます。この関数は互換目的でサポートされています。
戻り値
- Return
ルートディレクトリのパス。
定義
- Signature
string getParentDirectory( string pathOrName )
詳細
- Details
親階層のパスを返します。
現在は getFilePath( pathOrName, PARENT ) で取得できます。この関数は互換目的でサポートされています。
引数
- Arguments
pathOrName : 対象ファイルの名称またはパス。
戻り値
- Return
親階層のパス。
定義
- Signature
string getFileRelativePath( string pathOrName, string directory )
詳細
- Details
指定ディレクトリから見た相対パスを、(実行プログラムから見た)相対パスに変換して返します。
現在は getFilePath( pathOrName, directory, RELARIVE ) で取得できます。この関数は互換目的でサポートされています。
引数
- Arguments
pathOrName : 対象ファイルの名称またはパス。
directory : 基準ディレクトリのパス。
戻り値
- Return
親階層のパス。
定義
- Signature
string[ ] getFileList( string pathOrName )
詳細
- Details
指定ディレクトリ直下のファイル名一覧を取得します。
現在は listFile( pathOrName ) で取得できます。この関数は互換目的でサポートされています。
この関数では、ファイル名の整列順序は環境やオペレーティングシステムに依存します。特定の順序である事を前提とした処理は推奨されません。新しい listFile( pathOrName ) は整列オプションを指定できます。
引数
- Arguments
pathOrName : 対象ディレクトリの名称またはパス。
戻り値
- Return
指定ディレクトリ直下のファイル名一覧(順序は環境依存)


スポンサーリンク



スポンサーリンク

この階層の目次
お知らせ

リニアンプロセッサー nano の先行開発版やソースコードリポジトリを公開
2019年04月16日 - オープンソースで開発中の小型プログラム関数電卓ソフト、「 リニアンプロセッサー nano 」の先行開発版やソースコードリポジトリを公開しました。概要と使用方法、ビルド方法などについて解説します。

各ソフトウェアの最新版を一括でリリース、OpenJDKのJava実行環境(JRE)に対応
2019年03月06日 - RINEARNでは3月6日に、主要なソフトウェアの最新版を一括でリリースしました。今回のアップデートには、以前お知らせした、OpenJDKで生成したJREへの対応が含まれています。その概要等をお知らせします。

次回のVCSSL 3.4.10において、関数1個の挙動に非互換な修正が適用されます
2019年02月12日 - VCSSLの次回の正式リリース版3.4.10において、これまでドキュメントと実際の挙動が異なっていた描画系の関数1個に、非互換な修正が適用されます。その詳細と、使用コードでの対応方法について解説します。

新着
画像を任意サイズに拡大・縮小する簡易ツール(複数ファイル一括処理版)

フォルダ内にある全ての画像ファイルを開き、任意のサイズに拡大・縮小して、別のフォルダに保存する簡易ツールです。
2019年03月29日
画像を任意サイズに拡大・縮小する簡易ツール

画像ファイルを開き、任意のサイズに拡大・縮小して、別名で保存する簡易ツールです。
2019年03月28日
画像の矩形(四角形)領域を切り抜く簡易ツール(複数ファイル一括処理版)

フォルダ内にある全ての画像ファイルを開き、その中の矩形(四角形)領域を切り抜いて、別のフォルダに保存する簡易ツールです。
2019年03月15日
画像の矩形(四角形)領域を切り抜く簡易ツール

画像ファイルを開き、その中の矩形(四角形)領域を切り抜いて保存する簡易ツールです。
2019年03月14日
入力された数式を積分して値とグラフを表示するツール

画面上で数式を入力すると、それを数値的に積分し、値とグラフを表示してくれるGUIツールです。
2019年01月20日
開発元Twitterアカウント