mxSetName (External Interfaces/API Reference)

Set the name of an mxArray

C Syntax

#include "matrix.h"
void mxSetName(mxArray *array_ptr, const char *name);

Arguments
array_ptr
Pointer to an mxArray.

name

The name you are assigning to the mxArray. The specified name can be up to mxMAXNAM characters, where mxMAXNAM is a constant defined in the matrix.h header file. If you specify a name longer than mxMAXNAM-1 characters, then mxSetName assigns only the first mxMAXNAM-1 characters to the name.

Description

Call mxSetName to establish a name for an mxArray or to change an existing name.

mxSetName assigns the characters in name to a fixed-width section of memory. Do not deallocate this memory.

Example

See mexgetarray.c in the mex subdirectory of the examples directory.

See Also

mxGetName

mxSetN mxSetNzmax