mxArrayToString (C)

配列から文字列

C 構文

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

説明

mxArrayToString を呼び出して、mxCHAR 配列の文字データを C スタイル文字列にコピーします。C スタイル文字列は、必ず NULL 文字で終了し、列優先の順序で保存されます。配列に複数の行が含まれている場合、行が列方向にコピーされて単一の配列になります。

この関数は mxGetString に似ていますが、以下の点が異なります。

• mxArrayToString に文字列の長さの入力は不要。

• R2022a 以降、mxArrayToString は UTF-8 でエンコードされた文字列を返す。

入力引数

array_ptr — mxCHAR 配列へのポインター

const mxArray *

mxCHAR 配列へのポインター。const mxArray * として指定します。

出力引数

str — C スタイル文字列

char * | NULL

ローカル コード ページ (LCP) エンコードの C スタイル文字列。char * として指定します。配列を UTF-8 エンコードの文字列に変換するには、mxArrayToUTF8String を使用します。

失敗した場合は NULL を返します。失敗の原因としては、メモリ不足や、mxCHAR 配列ではない配列の指定などが考えられます。

例

matlabroot/extern/examples/mex の次の例を参照してください。

• mexatexit.c

matlabroot/extern/examples/mx の次の例を参照してください。

• mxcreatecharmatrixfromstr.c

バージョン履歴

R2006a より前に導入

参考

mxCreateString | mxGetString | mxArrayToUTF8String | mxCreateCharArray | mxCreateCharMatrixFromStrings