mustBeTextScalar

値が単一のテキストであることを検証

ページ内をすべて折りたたむ

構文

mustBeTextScalar(value)

説明

mustBeTextScalar(value) は、value がテキスト スカラーでない場合にエラーをスローします。テキスト スカラーとは単一のテキストですが、定義はデータ型によって異なります。

  • string 配列の場合、“text” などの単一のテキストは 1 行 1 列のスカラーです。空の string "" と欠損 string は、単一のテキストとしてもカウントされる特殊なケースです。

  • 文字列配列の場合、‘text’ などの単一のテキストは行ベクトルです。0 行 0 列の空の char 配列 '' は、単一のテキストとしてもカウントされる特殊なケースです。

  • string スカラーまたは文字ベクトルを含むスカラー cell の場合、mustBeTextScalar はエラーをスローします。

この関数は値を返しません。

例

例

すべて折りたたむ

text という名前の string の配列を作成してから、mustBeTextScalar を使用して値を検証します。変数に複数の string が含まれているため、mustBeTextScalar はエラーをスローします。

text = ["this" "will" "throw" "an" "error"];
mustBeTextScalar(text)
Value must be a character vector or string scalar.

mustBeTextScalar を使用して、関数によって受け入れられる入力引数値を制限します。これを行うには、入力引数を検証する関数に arguments ブロックを追加します。

この関数により、引数 textScalarInput の値がテキスト値に制限されます。

function MyFunction(textScalarInput)
   arguments
      textScalarInput {mustBeTextScalar}
   end
end

関数を呼び出します。MATLAB® は、引数に割り当てられている値に対して mustBeTextScalar を呼び出します。値 ["foo","bar"] がテキスト スカラーでないため、mustBeTextScalar はエラーを発行します。

MyFunction(["foo","bar"])
Error using MyFunction (line 3)
 MyFunction(["foo","bar"])
            ^^^^^^^^^^^^^
Invalid argument at position 1. Value must be a character vector or string scalar.

入力引数

すべて折りたたむ

検証する値。スカラーまたは配列として指定します。value が 1 行 1 列の string 配列、"" または <missing> string、行ベクトルの文字配列、または '' でない場合、mustBeTextScalar はエラーをスローします。

例: mustBeTextScalar('foo')

拡張機能

すべて展開する

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

バージョン履歴

R2020b で導入

参考

| |

トピック