File
File
オブジェクトは File
コマンドによって作成されます。 これらのオブジェクトには、(実在しているか否かに関わらず) ディスクファイルへの参照が格納されます。 たとえば、新規ファイルを作成するために File
コマンドを実行した場合、有効な File
オブジェクトが作成されますが、file.create()
関数を呼び出すまで、ディスク上にはなにも保存されていません。
例題
プロジェクトフォルダーにプリファレンスファイルを作成します:
var $created : Boolean
$created:=File("/PACKAGE/SpecialPrefs/"+Current user+".myPrefs").create()
パス名
File
オブジェクトは、filesystems
や posix
シンタックスを含む、いくつかのパス名をサポートしています。 使用できるパス名についての詳細は パス名 ページを参照ください。
File オブジェクト
File
履歴
リリース | 内容 |
---|---|
19 R4 | 新しい HTTP Client log file 定数 |
17 R5 | 追加 |
File ( path : Text { ; pathType : Integer }{ ; * } ) : 4D.File
File ( fileConstant : Integer { ; * } ) : 4D.File
引数 | タイプ | 説明 | |
---|---|---|---|
path | Text | -> | ファイルパス |
fileConstant | Integer | -> | 4Dファイル定数 |
pathType | Integer | -> | fk posix path (デフォルト) または fk platform path |
- | -> | ホストデータベースのファイルを返すには * を渡します | |
戻り値 | 4D.File | <- | 新規ファイルオブジェクト |
説明
File
コマンドは、4D.File
型の新しいオブジェクトを作成して返します。 このコマンドは 2 種類のシンタックスを受け入れます。
File ( path { ; pathType } { ; * })
path には、ファイルパス文字列を渡します。 カスタムの文字列または ファイルシステム (例: "/DATA/myfile.txt") を渡すことができます。
File
コマンドでは絶対パス名のみがサポートされます。
デフォルトで、4D は POSIXシンタックスで表現されたパスを期待します。 プラットフォームパス名 (Windows または macOS) を使用する場合、pathType 引数を使用してそのことを宣言する必要があります。 以下の定数を使用することができます:
定数 | 値 | 説明 |
---|---|---|
fk platform path | 1 | プラットフォーム特有のシンタックスで表現されたパス (プラットフォームパス名の場合には必須) |
fk posix path | 0 | POSIXシンタックスで表現されたパス (デフォルト) |
File ( fileConstant { ; * } )
fileConstant には、以下の定数のどれか一つを指定して 4Dビルトインの、またはシステムファイルを渡します:
定数 | 値 | 説明 |
---|---|---|
Backup history file | 19 | バックアップ履歴ファイル。 バックアップ保存先フォルダに保存されています。 |
Backup log file | 13 | カレントのバックアップのログファイル。 アプリケーション の Logs フォルダーに保存されています。 |
Backup settings file | 1 | プロジェクトの Settings フォルダーにある、デフォルトの backup.4DSettings ファイル (xml 形式) |
Backup settings file for data | 17 | データフォルダーの Settings フォルダーにある、データファイル用の backup.4DSettings ファイル (xml 形式) |
Build application log file | 14 | アプリケーションビルダーのカレントログファイル (xml 形式)。 Logs フォルダーに保存されています。 |
Build application settings file | 20 | アプリケーションビルダーのデフォルト設定ファイル ("buildApp.4DSettings")。 プロジェクトの Settings フォルダーに保存されています。 |
Compacting log file | 6 | Compact data file コマンドによって、あるいはメンテナンス&セキュリティセンター (MSC) によって作成された、直近の圧縮のログファイル。 Logs フォルダーに保存されています。 |
Current backup settings file | 18 | アプリケーションが現在使用している backup.4DSettings ファイル。 使用されるのはデフォルトのバックアップ設定ファイル、または、データファイル用のユーザーバックアップ設定ファイルです。 |
Debug log file | 12 | SET DATABASE PARAMETER(Debug log recording) コマンドによって作成されたログファイル。 Logs フォルダーに保存されています。 |
Diagnostic log file | 11 | SET DATABASE PARAMETER(Diagnostic log recording) コマンドによって作成されたログファイル。 Logs フォルダーに保存されています。 |
Directory file | 16 | プロジェクトアプリケーションにおいて、ユーザーとグループ (あれば) の定義が格納された directory.json ファイル。 このファイルは、データベースの user settings フォルダー (デフォルト、プロジェクトに対してグローバル)、または data settings フォルダー (データファイル専用) に保管されます。 |
HTTP Client log file | 24 | HTTP SET OPTION(HTTP client log) コマンドによって作成されたログファイル。 Logs フォルダーに保存されています。 |
HTTP debug log file | 9 | WEB SET OPTION(Web debug log) コマンドによって作成されたログファイル。 Logs フォルダーに保存されています。 |
HTTP log file | 8 | WEB SET OPTION(Web log recording) コマンドによって作成されたログファイル。 Logs フォルダーに保存されています。 |
IMAP Log file | 23 | SET DATABASE PARAMETER(IMAP Log) コマンドによって作成されたログファイル。 Logs フォルダーに保存されています。 |
Last backup file | 2 | 任意の場所に格納されている、最終バックアップファイル (名称は: \<applicationName>[bkpNum].4BK ) |
Last journal integration log file | 22 | 最後のログ統合ログファイル (あれば) の完全なパス名 (復元されたアプリケーションの Logs フォルダー内に保存されます)。 このファイルは、自動修復モードにおいてログファイル統合が発生した時点で作成されます。 |
Repair log file | 7 | メンテナンス&セキュリティセンター (MSC) 内からデータベースに対しておこなわれたデータベース修復のログファイル。 Logs フォルダーに保存されています。 |
Request log file | 10 | SET DATABASE PARAMETER(4D Server log recording) あるいは SET DATABASE PARAMETER(Client log recording) コマンドによって作成された標準のクライアント/サーバーログファイル (Webリクエストは除外)。 サーバー上で実行された場合には、サーバーログが返されます (ログファイルはサーバー上の Logsフォルダーに保存されています)。 クライアントで実行された場合には、クライアントのログが返されます (ログファイルはクライアントのLogsフォルダーに保存されています)。 |
SMTP log file | 15 | SET DATABASE PARAMETER(SMTP Log) コマンドによって作成されたログファイル。 Logs フォルダーに保存されています。 |
User settings file | 3 | 設定が有効化されている場合、ストラクチャーファイルと同じ階層にある Preferences フォルダーに格納された、全データファイルの settings.4DSettings ファイル。 |
User settings file for data | 4 | データファイルと同じ階層にある Preferences フォルダーに格納された、カレントデータファイルの settings.4DSettings ファイル。 |
Verification log file | 5 | VERIFY CURRENT DATA FILE および VERIFY DATA FILE コマンドによって、あるいはメンテナンス&セキュリティセンター (MSC) によって作成されたログファイル。 Logs フォルダーに保存されています。 |
fileConstant 引数で指定したファイルが存在しない場合、null オブジェクトが返されます。 エラーは生成されません。
コマンドがコンポーネントから呼び出されている場合、*
引数を渡してホストデータベースのパスを取 得するようにします。 *
引数を省略すると、常に null オブジェクトが返されます。
4D.File.new()
履歴
リリース | 内容 |
---|---|
18 R6 | 追加 |
4D.File.new ( path : Text { ; pathType : Integer } ) : 4D.File
4D.File.new ( fileConstant : Integer ) : 4D.File
説明
4D.File.new()
関数は、4D.File
型の新しいオブジェクトを作成して返します。 この関数の機能は、File
コマンドと同一です。
4D.File.new()
よりも、短いFile
コマンドの使用が推奨されます。
.copyTo()
履歴
リリース | 内容 |
---|---|
17 R5 | 追加 |
.copyTo( destinationFolder : 4D.Folder { ; newName : Text } { ; overwrite : Integer } ) : 4D.File
引数 | タイプ | 説明 | |
---|---|---|---|
destinationFolder | 4D.Folder | -> | 宛先フォルダー |
newName | Text | -> | コピー先フォルダーの名前 |
overwrite | Integer | -> | 既存要素を上書きするには fk overwrite を渡します |
戻り値 | 4D.File | <- | コピーされたファイル |
説明
.copyTo()
関数は、File
オブジェクトを、destinationFolder 引数で指定したフォルダーへとコピーします。
destinationFolder 引数が指定するフォルダーはディスク上に存在している必要があり、そうでない場合にはエラーが生成されます。
デフォルトで、ファイルは元の名前を維持したままコピーされます。 コピーの際にフォルダー名を変更したい場合、新しい名前を newName に渡します。 新しい名前は命名規則に則っている必要があります (例: ":", "/", 等の文字を含んでいない、など)。そうでない場合、エラーが返されます。
destinationFolder 引数が指定するフォルダー内に同じ名前のファイルが既 に存在する場合、4D はデフォルトでエラーを生成します。 overwrite に fk overwrite
定数を渡すことで、既存のフォルダーを無視して上書きすることができます:
定数 | 値 | 説明 |
---|---|---|
fk overwrite | 4 | 既存要素があれば、それを上書きします |
戻り値
コピーされた File
オブジェクト。
例題
ユーザーのドキュメントフォルダーにあるピクチャーファイルを、アプリケーションフォルダー内にコピーします。
var $source; $copy : Object
$source:=Folder(fk documents folder).file("Pictures/photo.png")
$copy:=$source.copyTo(Folder("/PACKAGE");fk overwrite)
.create()
履歴
リリース | 内容 |
---|---|
17 R5 | 追加 |
ZIPアーカイブには利用できません
.create() : Boolean
引数 | タイプ | 説明 | |
---|---|---|---|
戻り値 | Boolean | <- | ファイルが正常に作成された場合に true、それ以外の場合は false |
説明
.create()
関数は、File
オブジェクトのプロパティに基づいてディスク上にファイルを作成します。
必要であれば、 関数は platformPath あるいは path プロパティの詳細に基づいてフォルダー階層を作成します。 ファイルがディスク上にすでに存在する場合、関数は何もせず、false を返します (エラーは返されません)。
戻り値
- ファイルが正常に作成された場合には true
- すでに同じ名前のファイルが存在する、あるいはエラーが発生した場合には false
例題
データベースフォルダー内にプリファレンスファイルを作成します:
var $created : Boolean
$created:=File("/PACKAGE/SpecialPrefs/"+Current user+".myPrefs").create()
.createAlias()
履歴
リリース | 内容 |
---|---|
17 R5 | 追加 |
.createAlias( destinationFolder : 4D.Folder ; aliasName : Text { ; aliasType : Integer } ) : 4D.File
引数 | タイプ | 説明 | |
---|---|---|---|
destinationFolder | 4D.Folder | -> | エイリアスまたはショートカットの作成先フォルダー |
aliasName | Text | -> | エイリアスまたはショートカットの名称 |
aliasType | Integer | -> | エイリアスリンクのタイプ |
戻り値 | 4D.File | <- | エイリアスまたはショートカットのファイル参照 |
説明
.createAlias()
関数は、destinationFolder オブジェクトで指定されたフォルダー内に、aliasName が指定する名称で、対象ファイルへのエイリアス (macOS) またはショートカット (Windows) を作成します。
aliasName には、作成するエイリアスまたはショートカットの名前を渡します。
macOS 上では、この関数はデフォルトで標準エイリアスを作成します。 aliasType 引数を渡すことで、シンボリックリンクを作成することもできます。 以下の定数を使用 することができます:
定数 | 値 | 説明 |
---|---|---|
fk alias link | 0 | エイリアスリンク (デフォルト) |
fk symbolic link | 1 | シンボリックリンク (macOSのみ) |
Windows 上では、常にショートカット (.lnk ファイル) が作成されます (aliasType 引数は無視されます)。
返されるオブジェクト
isAlias
プロパティが true に設定された 4D.File
オブジェクトを返します。
例題
データベースフォルダー内のファイルへのエイリアスを作成します:
$myFile:=Folder(fk documents folder).file("Archives/ReadMe.txt")
$aliasFile:=$myFile.createAlias(File("/PACKAGE");"ReadMe")
.creationDate
履歴
リリース | 内容 |
---|---|
17 R5 | 追加 |
.creationDate : Date
説明
.creationDate
プロパティは、ファイルの作成日を返します。
このプロパティは 読み取り専用 です。
.creationTime
履歴
リリース | 内容 |
---|---|
17 R5 | 追加 |
.creationTime : Time