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

mxGetFieldNameByNumber

与えられた構造体配列のフィールド番号からフィールド名を取得

C 言語表示

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

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

戻り値

成功した場合は、n番目のフィールド名のポインタ。失敗した場合は、NULLを出力します。一般的な失敗の原因は以下の通りです。

• 構造体のmxArrayを指し示さないarray_ptrを指定。array_ptrが構造体のmxArrayを指すかどうかを決定するためには、mxIsStructを呼び出してください。
• 構造体のmxArrayのフィールド数以上のfield_numberの値を指定(field_number 0は最初のフィールドを表すので、index N-1は最後のフィールドを表します)。

詳細

mxGetFieldNameByNumberを呼び出すことによって、与えられた構造体mxArrayのフィールド名を取得します。mxGetFieldNameByNumberの一般的な利用法は、ループ内で呼び出して、与えられたmxArray内のすべてのフィールド名を取得することです。

つぎのように初期化されたMATLAB構造体を考えます。

patient.name = 'John Doe';
patient.billing = 127.00;
patient.test = [79 75 73; 180 178 177.5; 220 210 205];

field_number 0は、フィールド名nameを表します。field_number 1は、フィールド名billingを表します。field_number 2は、フィールド名testを表します。field_numberが0, 1, 2 以外の場合は、mxGetFieldNameByNumberはNULLを出力します。

例題

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

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

参考

mxGetField, mxIsStruct, mxSetField

mxGetFieldByNumber

mxGetFieldNumber