Documentation

This is machine translation

Translated by Microsoft
Mouse over text to see original. Click the button below to return to the English verison of the page.

mxArrayToString (C)

Array to string

C Syntax

#include "matrix.h"
char *mxArrayToString(const mxArray *array_ptr);

Arguments

array_ptr

Pointer to mxCHAR array.

Returns

C-style string. Returns NULL on failure. Possible reasons for failure include out of memory and specifying an array that is not an mxCHAR array.

Description

Call mxArrayToString to copy the character data of an mxCHAR array into a C-style string. The C-style string is always terminated with a NULL character.

If the array contains multiple rows, they are copied, one column at a time, into a single array.

This function is similar to mxGetString, except that:

  • It does not require the length of the string as an input.

  • It supports multibyte encoded characters.

mxArrayToString does not free the dynamic memory that the char pointer points to. Therefore, you typically free the mxArray (using mxFree) immediately after you have finished using it.

Examples

See the following examples in matlabroot/extern/examples/mex.

See the following examples in matlabroot/extern/examples/mx.

Introduced before R2006a

Was this topic helpful?