mxSetClassName (C)

Structure array to MATLAB object array

C Syntax

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

Arguments

array_ptr

Pointer to an mxArray of class mxSTRUCT_CLASS

classname

Object class to which to convert array_ptr

Returns

0 if successful, and nonzero otherwise. One cause of failure is that array_ptr is not a structure mxArray. Call mxIsStruct to determine whether array_ptr is a structure.

Description

mxSetClassName converts a structure array to an object array, to be saved subsequently to a MAT-file. The object is not registered or validated by MATLAB® software until it is loaded via the LOAD command. If the specified classname is an undefined class within MATLAB, LOAD converts the object back to a simple structure array.

Was this topic helpful?