mexPutVariable (Fortran)

MEX 関数から指定されたワークスペースへの配列

Fortran 構文

#include "fintrf.h"
integer*4 mexPutVariable(workspace, varname, pm)
character*(*) workspace, varname
mwPointer pm

引数

workspace

コピーする配列のスコープを指定します。workspace の値を以下に示します。

base

mxArray をベース ワークスペースにコピーします。

caller

mxArray を呼び出し側ワークスペースにコピーします。

global

mxArray をグローバル変数のリストにコピーします。

varname

ワークスペース内の mxArray の名前

pm

mxArray へのポインター

戻り値

成功した場合は 0、失敗した場合は 1。考えられる失敗の原因は、pm が 0 になっていることです。

説明

mexPutVariable を呼び出して、ポインター pm にある mxArray を MEX 関数から指定のワークスペースにコピーします。MATLAB® ソフトウェアによって、受け取り側ワークスペースにコピーされた mxArray に varname の名前が付けられます。

mexPutVariable により、MATLAB、ユーザー定義関数、他の MEX 関数などの他のエンティティで配列にアクセスできるようになります。

指定されたワークスペースに同じ名前の変数が存在する場合、mexPutVariable は変数の以前の内容を新しい mxArray の内容で上書きします。たとえば、MATLAB ワークスペースが変数 Peaches を以下のように定義するとします。

Peaches
1     2     3     4

そして、mexPutVariable を呼び出して Peaches を同じワークスペースにコピーします。

mexPutVariable("base", "Peaches", pm)

mexPutVariable によって渡される値は Peaches の古い値を置換します。

変数名には MATLAB 関数名を使用しないでください。関数名と競合する一般的な変数名には、i、j、mode、char、size、path などがあります。特定の名前が MATLAB 関数と関連しているかどうかを判断するには、関数 which を使用します。

バージョン履歴

R2006a より前に導入

参考