iptcheckstrs

パラメーター名の有効性のチェック

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

iptcheckstrs は将来のリリースで削除される予定です。代わりに validatestring を使用してください。

構文

param = iptcheckstrs(str,valid_strs,func_name,var_name,arg_pos)

説明

param = iptcheckstrs(str,valid_strs,func_name,var_name,arg_pos) は、str が有効なパラメーター名かどうかをチェックし、パラメーター名が無効の場合、形式を整えたエラー メッセージを発行します。

  • str と valid_strs の有効なパラメーター名が、大文字小文字の区別は無視するものの、それ以外は明確に一致している場合、iptcheckstrs は有効なパラメーター名を param に返します。

  • 一致しない場合または一致が不明瞭な場合、iptcheckstrs は、関数名 (func_name)、変数名 (var_name) および引数位置 (arg_pos) に関する情報を含む形式を整えたエラー メッセージを発行します。これらの値はエラー メッセージを作成するためにのみ使用され、パラメーターが有効かどうかのチェックには使用されません。

次の図では、エラー メッセージの形式と、iptcheckstrs 引数を使用してカスタマイズ可能な箇所を示します。

Formatted error message that includes a function name, argument position, variable name, and the valid parameter names.

例

例

すべて折りたたむ

有効なパラメーター名を含む文字ベクトルの cell 配列を定義します。エラー メッセージをトリガーするために、cell 配列内にない文字ベクトルを渡します。

validSuits = {'spades','hearts','diamonds','clubs'};
selectedSuit = iptcheckstrs('stars',validSuits,"isSuit","selectedSuit",2)
Function ISSUIT expected its second input argument, selectedSuit,
to match one of these:  spades, hearts, diamonds, clubs

The input, 'stars', did not match any of the valid strings.

有効なパラメーター名を含む文字ベクトルの cell 配列を定義します。cell 配列内の文字ベクトルと大文字か小文字かのみが異なるパラメーター名の有効性をチェックします。

validSuits = {'spades','hearts','diamonds','clubs'};
selectedSuit = iptcheckstrs('Spades',validSuits,"isSuit","selectedSuit",2)
selectedSuit =

    'spades'

入力引数

すべて折りたたむ

チェックするパラメーター名。文字ベクトルとして指定します。

有効なパラメーター名。文字ベクトルの cell 配列として指定します。

str が有効なパラメーター名でない場合にエラー メッセージに含まれる関数名。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

str が有効なパラメーター名でない場合にエラー メッセージに含まれる変数名。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

str が有効なパラメーター名でない場合にエラー メッセージに含まれる引数位置。正の整数として指定します。

出力引数

すべて折りたたむ

検証済みのパラメーター名。文字ベクトルとして返されます。

バージョン履歴

R2006a より前に導入

参考

| | | | |