mexGetVariable (C)

指定されたワークスペースからの変数のコピー

C 構文

#include "mex.h"
mxArray *mexGetVariable(const char *workspace, const char 
  *varname);

説明

メモ

最新の C++ の機能とC++ 用の MATLAB データ APIを使用して MEX 関数を作成するには、MATLAB (MEX ファイル) から呼び出せる C++ 関数の記述を参照してください。

mexGetVariable を呼び出して、指定された変数のコピーを取得します。返された mxArray には、変数が他のワークスペースにもっていたデータと特性のすべてのコピーが含まれています。返された mxArray を変更しても、mexPutVariable を使用してコピーをワークスペースに書き戻さない限り、ワークスペース内の変数には影響しません。

このルーチンによって作成された mxArray が不要になったときは、mxDestroyArray を使用して破棄します。

入力引数

workspace — ワークスペース

const char*

ワークスペース mexGetVariable は、const char* として指定されている varname を検索します。使用可能な値は以下のとおりです。

base	ベース ワークスペース内の変数を検索します。
caller	呼び出し側ワークスペース内の変数を検索します。
global	グローバル ワークスペース内の変数を検索します。

varname — 変数名

const char*

コピーする変数の名前。const char* として指定します。

出力引数

var — 変数のコピー

mxArray*

変数のコピー。mxArray* として指定します。失敗した場合、関数は NULL を返します。失敗の一般的な原因は、ワークスペースに現在存在しない変数を指定することです。このような変数は以前にワークスペースに存在していても、クリアされている可能性があります。

例

matlabroot/extern/examples/mex の次の例を参照してください。

• mexgetarray.c

バージョン履歴

R2006a より前に導入

参考

mexGetVariablePtr | mexPutVariable | mxDestroyArray | getVariable