mxRemoveField (External Interfaces/API Reference)

Remove a field from a structure array

C Syntax

#include "matrix.h"
extern void mxRemoveField(mxArray array_ptr, int field_number);

Arguments

array_ptr
Pointer to a structure mxArray.

field_number
The number of the field you want to remove. For instance, to remove the first field, set field_number to 0; to remove the second field, set field_number to 1; and so on.

Description

Call mxRemoveField to remove a field from a structure array. If the field does not exist, nothing happens. This function does not destroy the field values. Use mxDestroyArray to destroy the actual field values.

Consider a MATLAB structure initialized to

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

The field_number 0 represents the field name name; field_number 1 represents field name billing; field_number 2 represents field name test.

mxRealloc mxSetAllocFcns