mxArrayToString (C)

Array to string

expand all in page

C Syntax

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

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 and stored in column-major order. If the array contains multiple rows, then the rows are copied column-wise into a single array.

This function is similar to mxGetString, except that:

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

  • mxArrayToString supports both multi-byte and single-byte encoded characters. On Windows® and Linux® platforms, the user locale setting specifies the default encoding.

Input Arguments

expand all

Pointer to mxCHAR array, specified as const mxArray *.

Output Arguments

expand all

C-style string in local code page (LCP) encoding, specified as char *. To convert an array to a string in UTF-8 encoding, use mxArrayToUTF8String.

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

Examples

See these examples in matlabroot/extern/examples/mex:

See these examples in matlabroot/extern/examples/mx:

See Also

| | | |

Introduced before R2006a

MATLAB Documentation

Support