mxGetData (C)

非数値 mxArray 内のデータ要素

mxGetData は数値配列用には推奨されません。代わりに、型付きのデータアクセス関数を使用してください。詳細については、バージョン履歴を参照してください。

C 構文

#include "matrix.h"
void *mxGetData(const mxArray *pm);

説明

mxGetData は、非数値配列のみのデータ要素の取得に使用します。

数値配列の場合、インターリーブされた複素数 API で型付きのデータアクセス関数を使用するように、MEX ファイルを作成し、既存の MEX ファイルを更新することを MathWorks では推奨します。詳細については、以下を参照してください。

MEX ファイルをビルドするには、-R2018a オプションを指定して mex を呼び出します。

入力引数

すべて展開する

`pm` — 非数値 MATLAB^® 配列へのポインター
`mxArray *`

非数値 MATLAB 配列へのポインター。mxArray * として指定します。

出力引数

すべて展開する

`pa` — データ配列へのポインター
`void *` | `NULL`

mxArray 内のデータ配列へのポインター。void * として指定します。void ポインターは型のない値を指すので、戻り値は pm によって指定されている型に一致するポインター型にキャストします。MATLAB の型を対応する C の型にマッピングする場合の詳細については、mxClassID を参照してください。

pm が NULL の場合、関数は NULL を返します。

バージョン履歴

R2006a より前に導入

すべて展開する

R2018a: 複素数の `mxArray` の場合、`mxGetData` の戻り値のキャストはビルドオプションによって異なる

関数 mxGetData は void ポインターを返します。mxArray 入力引数で指定されている型に一致するポインターの型を、コードでは宣言しなければなりません。mxClassID を使用して正しい型を選択します。複素数入力の場合、正しい型は、MEX ファイルの作成に使用するビルドオプションによって異なります。

既定のリリース特定オプション (-R2017b) を使用して MEX ファイルをビルドする場合、関数は、実数のみの値の最初の要素を指すポインターを返します。

-R2018a オプションを使用して MEX ファイルをビルドする場合は、次のようになります。