Main Content

iptcheckhandle

ハンドルの有効性をチェック

説明

iptcheckhandle(obj,valid_types,func_name,var_name,arg_pos) は、obj オブジェクトが有効なグラフィックス オブジェクトであるかをチェックし、ハンドルが無効の場合、書式化されたエラー メッセージを発行します。

  • オブジェクトが valid_types で指定された有効なグラフィックス オブジェクトの場合、iptcheckhandle は何も返しません。

  • 連結性引数が無効の場合、iptcheckhandle は、関数名 (func_name)、変数名 (var_name) および引数位置 (arg_pos) に関する情報を含む書式化されたエラー メッセージを発行します。これらの値はエラー メッセージを作成するためにのみ使用され、グラフィックス オブジェクト ハンドルが有効かどうかのチェックには使用されません。

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

グラフィックス オブジェクトが座標軸でない場合のエラーのトリガー

エラー メッセージをトリガーするために、axes オブジェクトを含まない figure を作成し、次に、有効な axes のハンドルをチェックします。

fig = figure; % create figure without an axes
iptcheckhandle(fig,{'axes'},'my_function','my_variable',2)

fig は axes のハンドルではないため、iptcheckhandle はエラー メッセージを返します。

Function MY_FUNCTION expected its second input argument, my_variable,
to be one of these types:

 axes

Instead, its type was: figure.

入力引数

すべて折りたたむ

オブジェクト。ハンドルとして指定します。

グラフィックス オブジェクトの有効なタイプ。以下の文字ベクトルの 1 つ以上を含む cell 配列として指定します。

例: {'uipanel','figure'} は、有効なグラフィックス オブジェクトがパネル コンテナーまたは figure でなければならないことを指定します。

obj が無効なグラフィックス オブジェクトの場合にエラー メッセージに含まれる関数名。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

obj が無効なグラフィックス オブジェクトの場合にエラー メッセージに含まれる変数名。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

obj が無効なグラフィックス オブジェクトの場合にエラー メッセージに含まれる引数位置。正の整数として指定します。

バージョン履歴

R2006a より前に導入