mustBeFolder

入力パスがフォルダーを参照していることを検証

構文

mustBeFolder(path)

説明

mustBeFolder(path) は、path がフォルダーを参照していない場合にエラーをスローします。この関数は値を返しません。

mustBeFolder は以下の関数を呼び出して、入力がフォルダーを参照しているかどうかを判別します。

• isfolder

クラス サポート: すべての MATLAB^® クラス

例

フォルダー内での実行

関数 mustBeFolder を使用して、関数に渡されるフォルダー パスが有効なフォルダーであることを確認し、関数本体内の有効なフォルダーをテストするために条件文が使用されるのを回避します。

関数 runInFolder は、指定されたフォルダーで関数を実行するように変更する前に、そのフォルダーが有効であることを確認します。

function r = runInFolder(path)
    arguments
        path {mustBeFolder}
    end
    orgFolder = cd(path);
    r = myFunct;
    cd(orgFolder)
end

無効なフォルダー名を入力として渡すとエラーになります。

r = runInFolder("myFunct.m");

Error using runInFolder (line 3)
 r = runInFolder("myFunct.m");
                 ^^^^^^^^^^^
Invalid argument at position 1. These folders do not exist: 'myFunct.m'.

入力引数

path — フォルダーへのパス

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

1 つ以上のフォルダーへのパス。string スカラー、文字ベクトル、string 配列、または文字ベクトルの cell 配列として指定します。

例: "H:\myfolder\mysubfolder"

データ型: char | string

ヒント

• mustBeFolder は、プロパティと関数の引数の検証で使用されるように設計されています。

拡張機能

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

バージョン履歴

R2020b で導入

参考

arguments | mustBeFile

トピック

• 関数の引数の検証
• プロパティの検証関数