iptchecknargin

入力引数の数をチェック

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

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

構文

iptchecknargin(low,high,num_inputs,func_name)

説明

iptchecknargin(low,high,num_inputs,func_name) は、num_inputs が入力引数の数が有効であるかをチェックし、入力引数の数が無効の場合、形式を整えたエラー メッセージを発行します。

  • 入力引数の数が [low high] の範囲である場合、iptchecknargin は何も返しません。

  • 入力引数の数が low より小さいか high より大きい場合、iptchecknargin は、関数名 (func_name) に関する情報を含む形式を整えたエラー メッセージを発行します。この値はエラー メッセージを作成するためにのみ使用され、入力引数の数が有効かどうかのチェックには使用されません。

例

例

すべて折りたたむ

任意の数の入力引数を受け入れる test_function という名前の関数を作成します。この関数内で、iptchecknargin を呼び出して、関数に渡される引数の数が [1, 3] の範囲内であることをチェックします。関数を test_function.m というファイル名で保存します。

function test_function(varargin)
    iptchecknargin(1,3,nargin,mfilename);
end

MATLAB® コマンド ラインで関数を実行する際にエラー メッセージを出力させるために、必要以上の数の引数を指定します。

test_function(eye(3),5,pi,7)

入力引数

すべて折りたたむ

入力引数の数として有効な最小値。非負の整数として指定します。

入力引数の数として有効な最大値。非負の整数または Inf として指定します。

実際の入力引数の数。非負の整数として指定します。nargin を指定して、現在実行している関数の関数入力引数の数を使用することもできます。

num_inputs が入力引数の数として無効な場合にエラー メッセージに含まれる関数名。文字ベクトルまたは string スカラーとして指定します。mfilename を指定して、現在実行している関数の名前を使用することもできます。

データ型: char | string

バージョン履歴

R2006a より前に導入

参考

| | | | |