mexGetArray (外部インタフェース/API リファレンス)

別のワークスペースから変数のコピーを取得

C 言語表示

#include "mex.h"
mxArray *mexGetArray(const char *name, const char *workspace);

引数
name
MEX-ファイルワークスペースにコピーする変数名。

workspace

mexGetArray が変数nameを探すためにサーチするワークスペースを指定。取りうる値は以下の通りです。


`base`	カレントのMATLABワークスペースで変数`name`をサーチします。
`caller`	エントリ(M-ファイル、MEX-ファイル、MATLAB)がこのMEX-ファイルを呼び出したワークスペースで変数`name`をサーチします。
`global`	グローバル変数のリスト内で変数`name`をサーチします。変数`name`が存在し、グローバル変数とタグが付けられていない場合は、`mexGetArray`は`NULL`を出力します。

戻り値

成功した場合は、mxArray のコピーを出力します。失敗した場合は、NULLを出力します。一般的な失敗の原因は、カレントのワークスペースにないnameの指定によるものです。おそらく、変数は一度はワークスペースに存在しましたが、それ以降にクリアされました。

詳細

mexGetArrayを呼び出すことによって、指定した変数名をユーザのMEX-ファイルのワークスペースにコピーします。MEX-ファイルのワークスペースにあれば、MEX-ファイルは変数のデータと特性を調べたり修正することができます。

出力されるmxArrayには、変数name が他のワークスペースでもっていたすべてのデータと特性のコピーが含まれます。mexGetArrayは、出力されるmxArrayのnameフィールドを変数nameに初期化します。

例題

examplesディレクトリのmexサブディレクトリのmexgetarray.cを参照してください。

参考

mexGet mexGetArrayPtr