matGetVariableInfo (C および Fortran)
配列ヘッダー情報のみ
C 構文
#include "mat.h" mxArray *matGetVariableInfo(MATFile *mfp, const char *name);
Fortran 構文
#include "mat.h" mwPointer matGetVariableInfo(mfp, name) mwPointer mfp character*(*) name
引数
mfp
MAT ファイル情報へのポインター
name
MAT ファイルから取得する
mxArray
の名前
戻り値
mfp
が指し示す MAT ファイルからの name
の名前をもつ mxArray
のヘッダー情報を表す、新たに割り当てられた mxArray
構造体へのポインター。
name
の名前をもつ mxArray
のヘッダー情報を返すことができなかった場合、matGetVariableInfo
は、C では NULL
(Fortran では 0
) を返します。
説明
matGetVariableInfo
は、pr
、pi
、ir
、および jc
以外のすべてを含む配列ヘッダー情報のみを読み込みます。リーフ要素を通じてセルや構造体が再帰的に作成されますが、pr
、pi
、ir
、および jc
は含まれません。
matGetVariable
での読み込み時に pr
、pi
、ir
、および jc
が非ゼロ値の場合、matGetVariableInfo
はこれらを代わりに -1
に設定します。これらのヘッダーは情報の提供のみが目的です。このデータを MATLAB® ワークスペースに渡したり、MAT ファイルに保存することは "決して" しないでください。
このルーチンによって作成された mxArray
が不要になったときは、mxDestroyArray
を使用して破棄します。
バージョン履歴
R2006a より前に導入