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

構造体配列の中のフィールド値、与えられたフィールド番号とインデックスを取得

C 言語表示

#include "matrix.h"
mxArray *mxGetFieldByNumber(const mxArray *array_ptr, int index, 
         int field_number);

引数
array_ptr
構造体mxArrayのポインタ。

index

希望する要素。mxArrayの最初の要素は0のindexをもち、2番目の要素は1のindexをもち、最後の要素はN-1のindexをもちます。ここで、Nは構造体mxArrayの要素の総数です。indexの計算の詳細は、mxCalcSingleSubscriptを参照してください。

field_number

取り出したい値をもつフィールドの位置。各要素内の最初のフィールドはフィールド番号が0、2番目のフィールドはフィールド番号が1、のようになります。最後のフィールドは、フィールド番号がN-1です。ここで、Nはフィールド数です。

戻り値

成功した場合は、希望する要素の指定したフィールド内のmxArrayのポインタ。無効な引数を渡したり、指定したフィールドに値が割り当てられていない場合は、NULLを出力します。一般的な失敗の原因は以下の通りです。

構造体のmxArrayを指し示さないarray_ptrを指定。array_ptrが構造体のmxArrayを指すかどうかを決定するためには、mxIsStructを呼び出してください。

配列内の要素数よりも大きいインデックスまたは負のインデックスを指定。

存在しないフィールド番号を指定。存在するフィールド名を決定するには、mxGetFieldNameByNumberまたはmxGetFieldNumberを呼び出してください。

詳細

mxGetFieldByNumber を呼び出すことによって、インデックス付けられた要素の指定したfield_numberにある値を取得します。

注意 MEX-ファイルの入力は、リードオンリーのmxArrayの定数で、変更できません。mxSetCell*またはmxSetField*を使って、MATLABから渡される引数のセルまたはフィールドを変更すると、予期しない結果になることがあります。

mxGetField(pa, index, "field_name");

の呼び出しは、以下の呼び出しと等価です。

field_num = mxGetFieldNumber(pa, "field_name");
mxGetFieldByNumber(pa, index, field_num);

ここで、1行1列の構造体をもつ場合はindexはゼロです。

例題

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

さらに、examplesディレクトリのmxサブディレクトリのmxisclass.cと、examplesディレクトリのmexサブディレクトリのexplore.cを参照してください。

参考

mxGetField, mxGetFieldNameByNumber, mxGetFieldNumber, mxGetNumberOfFields, mxSetField, mxSetFieldByNumber

mxGetField mxGetFieldNameByNumber