mxCreateString (C)

1-D array initialized to specified string

C Syntax

#include "matrix.h"
mxArray *mxCreateString(const char *str);

Description

Use mxCreateString to create an mxArray initialized from str.

Call mxDestroyArray when you finish using the mxArray.

Input Arguments

str — String

const char *

String, specified as const char *. This string can be encoded using UTF-8 or, for backward compatibility, the local code page (LCP) encoding.

Output Arguments

pm — Pointer to mxArray

mxArray * | NULL

Pointer to an mxArray, specified as mxArray *, if successful.

The function is unsuccessful when there is not enough free heap space to create the mxArray.

• MEX file — Function terminates the MEX file and returns control to the MATLAB^® prompt.

• Standalone (non-MEX file) application — Function returns NULL.

Examples

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

• revord.c

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

• mxcreatestructarray.c

• mxisclass.c

Version History

Introduced before R2006a

R2020b: UTF-8 support added

The mxCreateString function accepts UTF-8 encoded data in addition to supporting local code page (LCP) encoded strings for backward compatibility.