MATLAB Application Program Interface Reference Help Desk

mxGetFieldNumber

Purpose

Get a field number, given a field name in a structure array

C Syntax

Arguments

array_ptr

Pointer to a structure mxArray.

field_name

The name of a field in the structure mxArray.

Returns

The field number of the specified field_name, on success. The first field has a field number of 0, the second field has a field number of 1, and so on. Returns -1 on failure. Common causes of failure include:

Description

If you know the name of a field but do not know its field number, call mxGetFieldNumber. Conversely, if you know the field number but do not know its field name, call mxGetFieldNameByNumber.

For example, consider a MATLAB structure initialized to

The field_name "name" has a field number of 0; the field_name "billing" has a field_number of 1; and the field_name "test" has a field number of 2. If you call mxGetFieldNumber and specify a field_name of anything other than "name", "billing", or "test", then mxGetFieldNumber returns -1.

Example

See mxGetFieldNumber.c in the mx subdirectory of the examples directory.

See Also

mxGetField, mxGetFieldByNumber, mxGetFieldNameByNumber, mxGetNumberOfFields, mxSetField, mxSetFieldByNumber



[ Previous | Help Desk | Next ]