Main Content

本页的翻译已过时。点击此处可查看最新英文版本。

mustBeTextScalar

验证值是一段文本

说明

示例

如果 value 不是文本标量,则 mustBeTextScalar(value) 会引发错误。文本标量是一段文本,但定义因数据类型而异:

  • 对于字符串数组,一段文本是一个 1×1 标量,如 “text”。空字符串 "" 和缺失字符串是特殊情况,也记为单段文本。

  • 对于字符数组,一段文本是一个行向量,如 ‘text’。空的 0×0 字符数组 '' 是一种特殊情况,也记为一段文本

此函数不返回值。

示例

全部折叠

创建一个名为 text 的字符串数组,然后使用 mustBeTextScalar 验证值。mustBeTextScalar 会引发错误,因为该变量包含多个字符串。

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

使用 mustBeTextScalar 来限制函数接受的输入参数值。您可以通过向验证输入参数的函数添加参数代码块来实现这一点

此函数将参数 textScalarInput 的值限制为文本值。

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

调用该函数。MATLAB® 对分配给参数的值调用 mustBeTextScalarmustBeTextScalar 会发出错误,因为值 ["foo","bar"] 不是文本标量。

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

输入参数

全部折叠

要验证的值,指定为标量或数组。如果 value 不是 1×1 字符串数组、""<missing> 字符串、行向量字符数组或 ''mustBeTextScalar 将引发错误。

示例: mustBeTextScalar('foo')

版本历史记录

在 R2020b 中推出