file.copyTo( ) メソッドはFile オブジェクト(ソースファイル)をdestinationFolder 引数で指定したフォルダへとコピーを作成します。
destinationFolder 引数で指定したフォルダはディスク上に存在している必要があります。そうでない場合、エラーが生成されます。
デフォルトでは、ファイルはオリジナルのファイルと同じ名前でコピーされます。コピー先に別の名前を付けたい場合、新しい名前をnewName 引数へと渡します。新しい名前は命名規則(例: ":", "/", などの文字を含んではいけない等)にのっとっている必要があり、そうでない場合にはエラーが返されます。
引数で指定したフォルダ内に同じ名前のファイルが既に存在する場合、デフォルトでは4D はエラーを生成します。overwrite 引数にfk overwrite 定数を渡すことで、既存のファイルを無視して上書きすることができます:
定数 |
値 |
コメント |
fk overwrite |
4 |
既存の要素があれば、それを上書きします。 |
返されるオブジェクト
このメソッドはコピーされたFile オブジェクトを返します。
ユーザーのドキュメントフォルダから、データベースフォルダ内へとピクチャーファイルをコピーしたい場合を考えます。