copyfile

ファイルまたはフォルダーをコピーする

構文

copyfile source

copyfile source destination

copyfile source destination f

copyfile(source,destination,CopyLinkBehavior=slbehavior)

status = copyfile(___)

[status,msg] = copyfile(___)

[status,msg,msgID] = copyfile(___)

説明

copyfile source は、source ファイルまたはフォルダーを現在のフォルダーにコピーします。copyfile 操作が正常に完了した後、新規ファイルのタイムスタンプは、source のタイムスタンプと同じになります。

copyfile source destination は source をファイルまたはフォルダーの destination にコピーします。

• source がファイルの場合、destination にはファイルまたはフォルダーを指定できます。

• source がフォルダーの場合、destination はフォルダーでなければなりません。

• source にフォルダーまたは複数のファイルが指定され、かつ destination が存在しない場合、copyfile は destination を作成しようとします。

copyfile source destination f は、destination が書き込み不可の場合でも、source を destination にコピーします。destination の読み取り/書き込み属性の状態は変化しません。

copyfile(source,destination,CopyLinkBehavior=slbehavior) は、シンボリック リンクまたはそのターゲットをコピーするかどうかを指定します。 (R2024b 以降)

status = copyfile(___) は指定されたファイルまたはフォルダーをコピーし、操作が正常に完了した場合はステータス 1 を返します。それ以外の場合、copyfile は 0 を返します。この構文では、前述の構文の入力引数を任意に組み合わせて使用できます。

[status,msg] = copyfile(___) は、発生した警告またはエラーに関するメッセージ テキストも返します。

[status,msg,msgID] = copyfile(___) は、発生した警告またはエラーに関するメッセージ ID も返します。

例

ファイルを別フォルダーにコピーする

現在のフォルダーにある myfile1.m をサブフォルダー myFolder にコピーします。

mkdir myFolder
copyfile myfile1.m myFolder

現在のフォルダーにファイルのコピーを作成

現在のフォルダー内に myfile1.m のコピーを作成し、myfile2.m という名前を割り当てます。

copyfile myfile1.m myfile2.m

新しいフォルダーにファイルとフォルダーをコピー

newFolder がまだ存在していないときに、名前が my で始まるファイルとサブフォルダーを現在のフォルダーから newFolder フォルダーにコピーします。

copyfile my* newFolder

ファイルを読み取り専用フォルダーにコピー

myfile1.m ファイルを現在のフォルダーから読み取り専用の restricted フォルダーにコピーします。

読み取り専用の restricted フォルダーを作成します。

mkdir restricted
fileattrib restricted -w

ファイルをコピーして、myfile1.m というファイル名に変更します。ステータスが 0 の場合、コピーは失敗しています。

status = copyfile('myfile1.m', 'restricted');
status

status = logical
   0

コピー先フォルダーの読み取り専用ステータスをオーバーライドする 'f' オプションを使用して、myfile1.m ファイルをコピーします。ステータスが 1 で message と messageId が空である場合は、コピーが正常に完了したことを示します。

[status,message,messageId] = copyfile('myfile1.m', 'restricted', 'f');
status

status = logical
   1

message

message =

  0×0 empty char array

messageId

messageId =

  0×0 empty char array

入力引数

source — コピー元のファイルまたはフォルダー

string スカラー | 文字ベクトル

コピー元のファイルまたはフォルダー。string スカラーまたは文字ベクトルとして指定します。複数のファイルまたはフォルダーをコピーするには、ワイルドカード (*) を使用します。複数のファイルまたはフォルダーをコピーすると、copyfile はコピー可能なファイルまたはフォルダーのみをコピーします。

ローカルのファイルまたはフォルダーをコピーする場合、source には絶対パスまたは相対パスを指定できます。ただし、リモートの場所にあるファイルとフォルダーの場合は、絶対パスを Uniform Resource Locator (URL) として指定する必要があります。インターネット URL には、プロトコル タイプ "http://" または "https://" を含める必要があります。詳細については、リモート データの操作を参照してください。

メモ

source が string の場合は、すべての入力をかっこで囲みます。たとえば、copyfile("myfile.m","newfolder") のようになります。

destination — コピー先のファイルまたはフォルダー

string スカラー | 文字ベクトル

ファイルまたはフォルダーのコピー先。string スカラーまたは文字ベクトルとして指定します。destination にワイルドカード (*) は使用できません。

destination がローカルの場所の場合は、絶対パスまたは相対パスを指定できます。source がフォルダーで destination のフォルダーが存在しない場合、copyfile はフォルダーを作成します。source がファイルで destination のフォルダーが存在しない場合、copyfile はフォルダー名を使用して拡張子なしのファイルを代わりに作成します。コピー先フォルダーにファイルを書き込むには、フォルダーが事前に存在していなければなりません。

destination がリモートの場所の場合は、URL の絶対パスを指定する必要があります。詳細については、リモート データの操作を参照してください。

メモ

destination が string の場合は、すべての入力をかっこで囲みます。たとえば、copyfile("myfile.m","newfolder") のようになります。

slbehavior — シンボリック リンクの動作

"osdefault" (既定値) | "preserve" | "resolve"

R2024b 以降

シンボリック リンクの動作。次の値のいずれかとして指定します。

• "osdefault" – ファイル システムの既定の動作を使用します。

• "preserve" – シンボリック リンクをコピーし、コピー先にシンボリック リンクとして保存します。シンボリック リンクのターゲットは変わりません。

• "resolve" – シンボリック リンクのターゲットをコピーします。

出力引数

status — コピーのステータス

0 | 1

コピーのステータス。ファイルまたはフォルダーの移動の試行が正常に完了したかどうかを表し、0 または 1 として返されます。試行が正常に完了していれば、status の値は 1 になります。それ以外の場合、この値は 0 です。

データ型: logical

msg — エラー メッセージ

文字ベクトル

エラー メッセージ。文字ベクトルとして返されます。エラーまたは警告が発生した場合、msg にはエラーまたは警告のメッセージ テキストが格納されます。それ以外の場合、msg は空 ('') です。

msgID — エラー メッセージ識別子

文字ベクトル

エラー メッセージ識別子。文字ベクトルとして返されます。エラーまたは警告が発生した場合、msgID にはエラーまたは警告のメッセージ ID が格納されます。それ以外の場合、msgID は空 ('') です。

制限

• MATLAB^® では、認証が必要なインターネット URL はサポートされていません。

• MATLAB Online™ では Microsoft^® OneDrive™ ファイルおよびフォルダーに関連付けられたインターネット URL はサポートされていますが、MATLAB のインストール バージョンではローカル OneDrive ファイルのみがサポートされています。

ヒント

• この関数は Microsoft Windows^® ショートカット ファイル (.lnk) をサポートしています。

拡張機能

C/C++ コード生成

MATLAB® Coder™ を使用して C および C++ コードを生成します。

使用上の注意および制限:

• 関数 copyfile では、ワイルドカード操作や URL は入力としてサポートされません。

• MATLAB から生成されたコードは、それを MATLAB 内で実行した場合と異なる動作になることがあります。

  その場合、生成コードでのファイル処理は、Windows プラットフォームでは関数 CopyFileExA、UNIX^® システムでは C 言語の関数 read および write と同様になります。

スレッドベースの環境
MATLAB® の backgroundPool を使用してバックグラウンドでコードを実行するか、Parallel Computing Toolbox™ の ThreadPool を使用してコードを高速化します。

バージョン履歴

R2006a より前に導入

R2024b: ファイル操作関数を使用した HTTP および HTTPS を介したデータの読み取り

インターネット URL を介してファイル読み取り操作を実行することで、主要なオンライン ソースからデータを読み取ることができます。

R2024b: シンボリック リンクを使用したファイルとフォルダーの操作

シンボリック リンクを使用して、ファイルとフォルダーをコピーできます。シンボリック リンクをソースとして指定する際に、シンボリック リンク自体をコピーするのか、そのターゲットをコピーするのかを制御できます。

R2020a: UNIX プラットフォームでのワイルドカード表現 *.* で一致する対象となるのは、拡張子のあるファイルのみ

R2020a 以降、UNIX プラットフォームでは、ワイルドカード表現 *.* はフォルダーまたは拡張子のないファイルと一致しなくなりました。以前のリリースでは、この表現は、拡張子のないファイルも含め、ファイルの拡張子に関係なくフォルダーまたはファイルと一致していました。この動作の変更は、Microsoft Windows プラットフォームには適用されません。

R2020a: シンボリック リンクをプラットフォームとファイル システムで一貫して処理

シンボリック リンク (symlink) は、ターゲット ファイルまたはフォルダーを指すファイル システム オブジェクトです。R2020a 以降、symlink ファイルまたはフォルダーに対する操作時の関数 copyfile の動作が変わります。

• コピー結果はプラットフォームに依存: copyfile は、異なるオペレーティング システムでも symlink を同様に処理するようになりました。たとえば、ファイル myFile.m と myFile.m を指す symlink (symlinkToMyFile として指定) を含むフォルダー構造について考えます。

  myFile.m
  symlinkToMyFile
  

  R2020a 以降、copyfile('symlinkToMyFile','newFile') は symlink のターゲット (つまり、myFile.m) をコピー先にコピーします。以前のリリースでは、Linux^® の場合、copyfile は代わりに symlink をコピーします。

  プラットフォーム	newFile (R2020a 以降)	newFile (R2019b 以前)
  Linux	myFile.m	symlinkToMyFile
  Mac	myFile.m	myFile.m
  Windows	myFile.m	myFile.m

• copyfile はソース フォルダーの内容のみをコピー: 空でないフォルダーを symlink フォルダーにコピーする場合、copyfile は、ソース フォルダー全体ではなくソース フォルダーの内容 (つまり、ソース フォルダー内のファイルとフォルダー) をコピーするようになりました。同様に、symlink フォルダーをコピー先フォルダーにコピーする場合も、symlink フォルダーの内容のみがコピーされます。

  たとえば、空でないフォルダー myFolder と、symlinkToMyFolder という名前のそのフォルダーへの symlink とで構成される Linux 上のフォルダー構造について考えます。次の表に、異なる MATLAB リリースにおける copyfile('myFolder','simlinkToMyFolder') の実行後のフォルダー構造を示します。

  コピー前のフォルダー構造	コピー後のフォルダー構造 (R2020a 以降)	コピー後のフォルダー構造 (R2019b 以前)
  myFolder myFile.m symlinkToMyFolder	myFolder myFile.m symlinkToMyFolder myFile.m	myFolder myFile.m symlinkToMyFolder myFolder myFile.m

参考

関数

• cd | delete | dir | mkdir | movefile | rmdir

トピック

• ファイルおよびフォルダー管理
• ファイル名の指定
• リモート データの操作